### System Prompt Example

Source: https://sitespeak.ai/blog/using-ai-to-make-learning-personal-and-increase-your-online-course-sales

An example of a system prompt to instruct the chatbot on its persona, knowledge base, and how to guide students to additional resources.

```text
You are a kind and friendly expert in Notion. You are able to answer questions based on the Notion course content you have been trained on. When applicable, refer the visitor to the author of the course, Thomas Frank's website here: https://thomasjfrank.com where they can find more information.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/help-center/getting-started/how-do-i-create-my-custom-trained-chatgpt-chatbot

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/blog/using-ai-to-make-learning-personal-and-increase-your-online-course-sales

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### SiteSpeak AI Installation Guides

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-chatgpt-to-telegram

A collection of guides detailing how to integrate SiteSpeak AI chatbots into various popular platforms and website builders.

```APIDOC
Platform Integration Guides:
  Purpose: To provide step-by-step instructions for embedding SiteSpeak AI chatbots into different environments.
  Platforms Covered:
    - HTML: Add ChatGPT To HTML
    - Framer: Add a ChatGPT widget to Framer
    - Shopify: Add ChatGPT To Shopify
    - Notion: Add ChatGPT To Notion
    - Wordpress: Add ChatGPT To Wordpress
    - Carrd: Add ChatGPT To Carrd
    - Bubble: Add ChatGPT To Bubble
    - Webflow: Add ChatGPT To Webflow
    - Slack: Add ChatGPT To Slack
    - Showit: Add a ChatGPT chatbot to Showit
  Related Integration:
    - Zapier: Add Zapier Integration
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/what-sources-can-i-use-to-train-my-chatbot

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Chatbots Installation API

Source: https://sitespeak.ai/register

Provides endpoints for managing chatbot installations. Includes methods to retrieve installation details.

```APIDOC
chatbots.installation.index:
  uri: chatbots/{chatbot}/installation
  methods: [GET, HEAD]
  domain: sitespeak.ai
  parameters: [chatbot]
  description: Retrieves installation details for a specific chatbot.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-chatgpt-to-shopify

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Chatbots Installation API

Source: https://sitespeak.ai/login

Provides endpoints for managing chatbot installations. Includes methods to retrieve installation details.

```APIDOC
chatbots.installation.index:
  uri: chatbots/{chatbot}/installation
  methods: [GET, HEAD]
  domain: sitespeak.ai
  parameters: [chatbot]
  description: Retrieves installation details for a specific chatbot.
```

--------------------------------

### Blog and Examples API

Source: https://sitespeak.ai/register

Endpoints for accessing blog content and specific examples or use cases. Supports retrieving blog posts by slug and examples by slug.

```APIDOC
Blog and Examples:

blog:
  uri: blog
  methods: [GET, HEAD]
  domain: sitespeak.ai

blog.post.show:
  uri: blog/{post}
  methods: [GET, HEAD]
  domain: sitespeak.ai
  parameters: [post]
  bindings: {post: slug}

examples:
  uri: use-cases-and-examples
  methods: [GET, HEAD]
  domain: sitespeak.ai

examples.example.show:
  uri: use-cases-and-examples/{example}
  methods: [GET, HEAD]
  domain: sitespeak.ai
  parameters: [example]
  bindings: {example: slug}
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/how-can-i-create-my-own-custom-gpt

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Blog and Examples API

Source: https://sitespeak.ai/login

Endpoints for accessing blog content and specific examples or use cases. Supports retrieving blog posts by slug and examples by slug.

```APIDOC
Blog and Examples:

blog:
  uri: blog
  methods: [GET, HEAD]
  domain: sitespeak.ai

blog.post.show:
  uri: blog/{post}
  methods: [GET, HEAD]
  domain: sitespeak.ai
  parameters: [post]
  bindings: {post: slug}

examples:
  uri: use-cases-and-examples
  methods: [GET, HEAD]
  domain: sitespeak.ai

examples.example.show:
  uri: use-cases-and-examples/{example}
  methods: [GET, HEAD]
  domain: sitespeak.ai
  parameters: [example]
  bindings: {example: slug}
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/how-do-i-add-sitespeakai-to-my-website

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/how-long-does-it-take-to-train-a-chatbot

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### SiteSpeak AI Chatbot Installation Snippet

Source: https://sitespeak.ai/help-center/installing-your-chatbot

This section appears to be an HTML snippet or instruction for installing a SiteSpeak AI chatbot. It includes a comment indicating the project and content source, followed by a JavaScript block that likely embeds or configures the chatbot on a webpage.

```html
Site SpeakAI - Installing Your Chatbot
```

--------------------------------

### Agent Initialization and Event Handling

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-chatgpt-to-shopify

Illustrates the initialization of agent features and the setup of event listeners for various lifecycle events like DOMContentLoaded, load, and navigation. It also shows how to handle API send events.

```javascript
var z=function(e){p(u.eY,(function(t){return function(e,t){
const r={};
let i,o;
(0,l.R)(54,"newrelic.register")
e.init.api.allow_registered_children||(i=()=>(0,l.R)(55))
t&&(0,F.I)(t)||(i=()=>(0,l.R)(48,t))
const a={
addPageAction:(n,i={})=>{
u(V,[n,{...r,...i},e],t)
},
log:(n,i={})=>{
u(G,[n,{...i,customAttributes:{...r,...i.customAttributes||{}}},e],t)
},
noticeError:(n,i={})=>{
u(U,[n,{...r,...i},e],t)
},
setApplicationVersion:e=>{
r["application.version"]=e
},
setCustomAttribute:(e,t)=>{r[e]=t},
setUserId:e=>{r["enduser.id"]=e},
metadata:{customAttributes:r,target:t,get connected(){return o||Promise.reject(new Error("Failed to connect"))}}
}

i?i():o=new Promise(((n,i)=>{try{
const o=e.runtime?.entityManager;
let s=!!o?.get
})))
}
}))
}

```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/zapier-integration

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-chatgpt-to-slack

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/use-cases-and-examples

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/can-the-chatbot-be-trained-on-bookstack-pages

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/tools/ai-score-my-site

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Agent Initialization and Event Handling

Source: https://sitespeak.ai/blog/using-ai-to-make-learning-personal-and-increase-your-online-course-sales

Illustrates the initialization of agent features and the setup of event listeners for various lifecycle events like DOMContentLoaded, load, and navigation. It also shows how to handle API send events.

```javascript
var z=function(e){p(u.eY,(function(t){return function(e,t){
const r={};
let i,o;
(0,l.R)(54,"newrelic.register")
e.init.api.allow_registered_children||(i=()=>(0,l.R)(55))
t&&(0,F.I)(t)||(i=()=>(0,l.R)(48,t))
const a={
addPageAction:(n,i={})=>{
u(V,[n,{...r,...i},e],t)
},
log:(n,i={})=>{
u(G,[n,{...i,customAttributes:{...r,...i.customAttributes||{}}},e],t)
},
noticeError:(n,i={})=>{
u(U,[n,{...r,...i},e],t)
},
setApplicationVersion:e=>{
r["application.version"]=e
},
setCustomAttribute:(e,t)=>{r[e]=t},
setUserId:e=>{r["enduser.id"]=e},
metadata:{customAttributes:r,target:t,get connected(){return o||Promise.reject(new Error("Failed to connect"))}}
}

i?i():o=new Promise(((n,i)=>{try{
const o=e.runtime?.entityManager;
let s=!!o?.get
})))
}
}))
}

```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/use-cases-and-examples/weather-information-bot

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-chatgpt-to-a-html-website

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/use-cases-and-examples/travel-and-tourism-chatbot

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/use-cases-and-examples/human-resources-hr-chatbot

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-chatgpt-to-wordpress

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/help-center/installing-your-chatbot/how-to-add-a-chatgpt-chatbot-to-showit

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/use-cases-and-examples/music-store-chatbot

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/use-cases-and-examples/ai-legal-and-divorce-advisor

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/can-i-create-a-chatbot-for-free

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/blog/sitespeakai-youtube-summarizer-seo-content

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/tools/llms-txt-generator

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### API: Entity Guid Retrieval

Source: https://sitespeak.ai/tools/is-openai-chatgpt-down

This APIDOC entry describes a method for retrieving an entity's GUID. It takes license key and application ID as input and handles potential timeouts or errors during the retrieval process. It also manages event listeners for entity additions to confirm successful retrieval.

```APIDOC
getEntityGuidFor(licenseKey, applicationID)
  - Retrieves the unique identifier (GUID) for an entity.
  - Parameters:
    - licenseKey (string): The license key associated with the entity.
    - applicationID (string): The application ID associated with the entity.
  - Returns:
    - entityGuid (string): The unique GUID of the entity if found.
    - Error: Throws an error if the retrieval fails or times out.
  - Dependencies:
    - Requires an active connection or service to resolve the GUID.
  - Notes:
    - Includes a timeout mechanism (15 seconds) for the retrieval process.
    - Listens for 'entity-added' events to confirm successful registration.
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/faq/i-still-have-questions-how-can-i-contact-you

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```

--------------------------------

### Tracer Setup and Methods

Source: https://sitespeak.ai/blog/create-an-ai-version-of-yourself-for-coaching

Sets up a tracer utility with methods for tracking function calls, errors, and SPA navigation. It provides a structured way to emit events related to application performance and behavior.

```APIDOC
TracerSetup:
  __constructor(tracerInstance, config)
    tracerInstance: The tracer object provided by the framework.
    config: Configuration object for the tracer setup.

  createTracer(name, callback, context)
    - Creates a traceable function wrapper.
    - Parameters:
      - name: String identifier for the traced function.
      - callback: The function to wrap and trace.
      - context: The 'this' context for the callback.
    - Returns: A wrapped function that emits start, error, and end events.
    - Usage Example:
      const tracedFunc = tracer.createTracer('myFunction', myFunction, this);
      tracedFunc.apply(this, args);

  Methods on Tracer Prototype:
    - actionText(text): Logs an action text event.
    - setName(name): Sets the name for the current tracing context.
    - setAttribute(key, value): Sets an attribute for the current tracing context.
    - save(): Saves the current tracing context.
    - ignore(): Ignores the current tracing context.
    - onEnd(callback): Registers a callback to be executed when the tracing context ends.
    - getContext(): Retrieves the current tracing context.
    - end(): Ends the current tracing context.
    - get(key): Retrieves a value from the tracing context.

  RouteName Tracking:
    - Logs route name changes for SPA navigation.
    - Parameters:
      - routeName: The new route name.
    - Context:
      - spa: SPA navigation context.
      - softNav: Soft navigation context.
    - Usage Example:
      tracer.emit('routeName', '/dashboard');
```