Merge pull request #303 from harishmohanraj/main

.github/workflows/deploy-website-mintlify.yml

@@ -7,12 +7,14 @@ on:
       - "autogen/**"
       - "website/**"
       - ".github/workflows/deploy-website-mintlify.yml"
+      - ".github/workflows/docs-check-broken-links.yml"
   push:
     branches: [main]
     paths:
       - "autogen/**"
       - "website/**"
       - ".github/workflows/deploy-website-mintlify.yml"
+      - ".github/workflows/docs-check-broken-links.yml"
   workflow_dispatch:
   merge_group:
     types: [checks_requested]

.github/workflows/docs-check-broken-links.yml

@@ -0,0 +1,29 @@
+name: Check docs for broken links
+
+on:
+  workflow_run:
+    workflows: ["mintlify docs"]
+    types:
+      - completed
+
+jobs:
+  check-broken-link:
+    if: |
+      github.event.workflow_run.conclusion == 'success' &&
+      github.event.workflow_run.head_branch == 'main'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+
+      - name: Install muffet
+        run: go install github.com/raviqqe/muffet/v2@latest
+
+      - name: Sleep for 5 minutes
+        run: sleep 300
+
+      - name: Check links using container
+        run: ./scripts/broken-links-check.sh

.muffet-excluded-links.txt

@@ -0,0 +1,33 @@
+linkedin.com
+x.com
+example.com
+rapidapi.com
+https://platform.openai.com/docs/
+https://github.com/ag2ai/ag2/blob/b1adac515931bf236ac59224269eeec683a162ba/test/oai/test_client.py
+https://github.com/ag2ai/ag2/blob/main/notebook/contributing.md
+https://github.com/openai/openai-python/blob/d231d1fa783967c1d3a1db3ba1b52647fff148ac/src/openai/resources/completions.py
+https://github.com/openai/openai-python/blob/d231d1fa783967c1d3a1db3ba1b52647fff148ac/src/openai/_client.py
+https://github.com/ag2ai/ag2/blob/main/autogen/agentchat/conversable_agent.py
+https://openreview.net/pdf?id=BAakY1hNKS
+https://docs.ag2.ai/_sites/docs.ag2.ai/docs/Gallery#contributing
+https://github.com/ag2ai/ag2/blob/main/notebook/contributing.md#how-to-get-a-notebook-displayed-on-the-website
+https://github.com/ag2ai/ag2/blob/main/autogen/agentchat/contrib/agent_builder.py
+https://github.com/qdrant/qdrant-client/blob/master/qdrant_client/qdrant_client.py
+https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/create_collection
+https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/create_field_index
+https://github.com/pgvector/pgvector?tab=readme-ov-file#hnsw
+https://github.com/chroma-core/chroma/blob/566bc80f6c8ee29f7d99b6322654f32183c368c4/chromadb/segment/impl/vector/local_hnsw.py
+https://github.com/nmslib/hnswlib#supported-distances
+https://github.com/ollama/ollama/blob/main/docs/api.md#parameters
+https://docs.ag2.ai/_sites/
+https://github.com/airtai/prompt-leakage-probing/blob/efe9c286236e92c4f6366daa60da2282add3ca95/prompt_leakage_probing/workflow/agents/prompt_leakage_black_box/prompt_leakage_black_box.py
+https://github.com/airtai/prompt-leakage-probing/blob/efe9c286236e92c4f6366daa60da2282add3ca95/prompt_leakage_probing/workflow/agents/prompt_leakage_classifier/prompt_leakage_classifier.py
+https://github.com/ag2ai/ag2/tree/main/autogen/agentchat/contrib/captainagent/tools/README.md
+https://docs.trychroma.com/troubleshooting#sqlite
+https://docs.ag2.ai/_sites/docs.ag2.ai/notebooks/agentchat_RetrieveChat#
+https://docs.ag2.ai/_sites/docs.ag2.ai/notebooks/agentchat_lmm_llava#
+https://docs.ag2.ai/_sites/docs.ag2.ai/docs/ecosystem/portkey#
+https://docs.ag2.ai/_sites/docs.ag2.ai/notebooks/agentchat_RetrieveChat_mongodb#
+https://docs.ag2.ai/_sites/docs.ag2.ai/notebooks/agentchat_RetrieveChat_pgvector#
+https://docs.ag2.ai/_sites/docs.ag2.ai/notebooks/Gallery#
+https://docs.ag2.ai/_sites/docs.ag2.ai/docs/topics/non-openai-models/cloud-gemini_vertexai#

autogen/agentchat/assistant_agent.py

@@ -63,7 +63,7 @@ def __init__(
                 default to None (no limit provided, class attribute MAX_CONSECUTIVE_AUTO_REPLY will be used as the limit in this case).
                 The limit only plays a role when human_input_mode is not "ALWAYS".
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](conversable_agent#__init__).
+                [ConversableAgent](conversable_agent#init).
         """
         super().__init__(
             name,

autogen/agentchat/contrib/agent_eval/critic_agent.py

@@ -37,7 +37,7 @@ def __init__(
                 Please override this attribute if you want to reprogram the agent.
             description (str): The description of the agent.
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](../../conversable_agent#__init__).
+                [ConversableAgent](../../conversable_agent#init).
         """
         super().__init__(
             name=name,

autogen/agentchat/contrib/agent_eval/quantifier_agent.py

@@ -37,6 +37,6 @@ def __init__(
                 Please override this attribute if you want to reprogram the agent.
             description (str): The description of the agent.
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](../../conversable_agent#__init__).
+                [ConversableAgent](../../conversable_agent#init).
         """
         super().__init__(name=name, system_message=system_message, description=description, **kwargs)

autogen/agentchat/contrib/agent_eval/subcritic_agent.py

@@ -38,7 +38,7 @@ def __init__(
                 Please override this attribute if you want to reprogram the agent.
             description (str): The description of the agent.
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](../../conversable_agent#__init__).
+                [ConversableAgent](../../conversable_agent#init).
         """
         super().__init__(
             name=name,

autogen/agentchat/contrib/graph_rag/neo4j_graph_rag_capability.py

@@ -14,7 +14,7 @@
 class Neo4jGraphCapability(GraphRagCapability):
     """
     The Neo4j graph capability integrates Neo4j Property graph into a graph rag agent.
-    Ref: https://neo4j.com/labs/genai-ecosystem/llamaindex/#_property_graph_constructing_modules/
+    Ref: https://neo4j.com/labs/genai-ecosystem/llamaindex/#_property_graph_constructing_modules
 
 
     For usage, please refer to example notebook/agentchat_graph_rag_neo4j.ipynb

autogen/agentchat/contrib/llamaindex_conversable_agent.py

@@ -56,7 +56,7 @@ def __init__(
             description (str): a short description of the agent. This description is used by other agents
                 (e.g. the GroupChatManager) to decide when to call upon this agent.
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](../conversable_agent#__init__).
+                [ConversableAgent](../conversable_agent#init).
         """
 
         if llama_index_agent is None:

autogen/agentchat/contrib/llava_agent.py

@@ -40,7 +40,7 @@ def __init__(
             system_message (str): system message for the ChatCompletion inference.
                 Please override this attribute if you want to reprogram the agent.
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](../conversable_agent#__init__).
+                [ConversableAgent](../conversable_agent#init).
         """
         super().__init__(
             name,

autogen/agentchat/contrib/math_user_proxy_agent.py

@@ -163,7 +163,7 @@ def __init__(
                     when the number of auto reply reaches the max_consecutive_auto_reply or when is_termination_msg is True.
             default_auto_reply (str or dict or None): the default auto reply message when no code execution or llm based reply is generated.
             max_invalid_q_per_step (int): (ADDED) the maximum number of invalid queries per step.
-            **kwargs (dict): other kwargs in [UserProxyAgent](../user_proxy_agent#__init__).
+            **kwargs (dict): other kwargs in [UserProxyAgent](../user_proxy_agent#init).
         """
         super().__init__(
             name=name,

autogen/agentchat/contrib/multimodal_conversable_agent.py

@@ -40,7 +40,7 @@ def __init__(
             system_message (str): system message for the OpenAIWrapper inference.
                 Please override this attribute if you want to reprogram the agent.
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](../conversable_agent#__init__).
+                [ConversableAgent](../conversable_agent#init).
         """
         super().__init__(
             name,

autogen/agentchat/contrib/qdrant_retrieve_user_proxy_agent.py

@@ -97,7 +97,7 @@ def __init__(
                 - payload_indexing: Whether to create a payload index for the document field. Default is False.
                   You can find more info about the payload indexing options at https://qdrant.tech/documentation/concepts/indexing/#payload-index
                   API Reference: https://qdrant.github.io/qdrant/redoc/index.html#tag/collections/operation/create_field_index
-             **kwargs (dict): other kwargs in [UserProxyAgent](../user_proxy_agent#__init__).
+             **kwargs (dict): other kwargs in [UserProxyAgent](../user_proxy_agent#init).
 
         """
         warnings.warn(

autogen/agentchat/contrib/retrieve_user_proxy_agent.py

@@ -220,7 +220,7 @@ def __init__(
                 - `distance_threshold` (Optional, float) - the threshold for the distance score, only
                     distance smaller than it will be returned. Will be ignored if < 0. Default is -1.
 
-            `**kwargs` (dict): other kwargs in [UserProxyAgent](../user_proxy_agent#__init__).
+            `**kwargs` (dict): other kwargs in [UserProxyAgent](../user_proxy_agent#init).
 
         Example:
 

autogen/agentchat/contrib/text_analyzer_agent.py

@@ -35,7 +35,7 @@ def __init__(
                 Please refer to [OpenAIWrapper.create](/docs/reference/oai/client#create)
                 for available options.
                 To disable llm-based auto reply, set to False.
-            **kwargs (dict): other kwargs in [ConversableAgent](../conversable_agent#__init__).
+            **kwargs (dict): other kwargs in [ConversableAgent](../conversable_agent#init).
         """
         super().__init__(
             name=name,

autogen/agentchat/user_proxy_agent.py

@@ -87,7 +87,7 @@ def __init__(
             description (str): a short description of the agent. This description is used by other agents
                 (e.g. the GroupChatManager) to decide when to call upon this agent. (Default: system_message)
             **kwargs (dict): Please refer to other kwargs in
-                [ConversableAgent](conversable_agent#__init__).
+                [ConversableAgent](conversable_agent#init).
         """
         super().__init__(
             name=name,

dotnet/website/articles/OpenAIChatAgent-use-json-mode.md

@@ -6,7 +6,7 @@ The following example shows how to enable JSON mode in @AutoGen.OpenAI.OpenAICha
 JSON mode is a new feature in OpenAI which allows you to instruct model to always respond with a valid JSON object. This is useful when you want to constrain the model output to JSON format only.
 
 > [!NOTE]
-> Currently, JOSN mode is only supported by `gpt-4-turbo-preview` and `gpt-3.5-turbo-0125`. For more information (and limitations) about JSON mode, please visit [OpenAI API documentation](https://platform.openai.com/docs/guides/text-generation/json-mode).
+> Currently, JOSN mode is only supported by `gpt-4-turbo-preview` and `gpt-3.5-turbo-0125`. For more information (and limitations) about JSON mode, please visit [OpenAI API documentation](https://platform.openai.com/docs/guides/structured-outputs#json-mode).
 
 ## How to enable JSON mode in OpenAIChatAgent.
 

notebook/agentchat_RetrieveChat.ipynb

@@ -15,7 +15,7 @@
     "## Table of Contents\n",
     "We'll demonstrate six examples of using RetrieveChat for code generation and question answering:\n",
     "\n",
-    "- [Example 1: Generate code based off docstrings w/o human feedback](#example-1)\n",
+    "- [Example 1: Generate code based off docstrings w/o human feedback](/notebooks/agentchat_RetrieveChat#example-1)\n",
     "- [Example 2: Answer a question based off docstrings w/o human feedback](#example-2)\n",
     "- [Example 3: Generate code based off docstrings w/ human feedback](#example-3)\n",
     "- [Example 4: Answer a question based off docstrings w/ human feedback](#example-4)\n",

notebook/agentchat_custom_model.ipynb

@@ -238,7 +238,7 @@
     "]\n",
     "```\n",
     "\n",
-    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/microsoft/autogen/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
+    "You can set the value of config_list in any way you prefer. Please refer to this [User Guide](https://docs.ag2.ai/docs/topics/llm_configuration) for full code examples of the different methods."
    ]
   },
   {

notebook/agentchat_groupchat.ipynb

@@ -10,7 +10,7 @@
     "AutoGen offers conversable agents powered by LLM, tool or human, which can be used to perform tasks collectively via automated chat. This framework allows tool use and human participation through multi-agent conversation.\n",
     "Please find documentation about this feature [here](https://docs.ag2.ai/docs/Use-Cases/agent_chat).\n",
     "\n",
-    "This notebook is modified based on https://github.com/ag2ai/FLAML/blob/4ea686af5c3e8ff24d9076a7a626c8b28ab5b1d7/notebook/autogen_multiagent_roleplay_chat.ipynb\n",
+    "This notebook is modified based on https://github.com/microsoft/FLAML/blob/4ea686af5c3e8ff24d9076a7a626c8b28ab5b1d7/notebook/autogen_multiagent_roleplay_chat.ipynb\n",
     "\n",
     "````{=mdx}\n",
     ":::info Requirements\n",

notebook/agentchat_planning.ipynb

@@ -97,7 +97,7 @@
     "]\n",
     "```\n",
     "\n",
-    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/ag2ai/ag2/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods.\n",
+    "You can set the value of config_list in any way you prefer. Please refer to this [User Guide](https://docs.ag2.ai/docs/topics/llm_configuration) for full code examples of the different methods.\n",
     "\n",
     "## Construct Agents\n",
     "\n",

notebook/agentchat_teachable_oai_assistants.ipynb

@@ -133,7 +133,7 @@
    "metadata": {},
    "source": [
     "## Teachable OpenAI Assistant with Functions\n",
-    "This section is based on [agentchat_oai_assistant_function_call.ipynb](https://github.com/microsoft/autogen/blob/teach_cap/notebook/agentchat_oai_assistant_function_call.ipynb), which demonstrates an assistant accomplishing a task through **function calling**."
+    "This section is based on [agentchat_oai_assistant_function_call.ipynb](https://github.com/ag2ai/ag2/blob/main/notebook/agentchat_oai_assistant_function_call.ipynb), which demonstrates an assistant accomplishing a task through **function calling**."
    ]
   },
   {
@@ -542,7 +542,7 @@
    "metadata": {},
    "source": [
     "## Teachable OpenAI Assistant with Code Interpreter\n",
-    "This section is based on [agentchat_oai_code_interpreter.ipynb](https://github.com/microsoft/autogen/blob/teach_cap/notebook/agentchat_oai_code_interpreter.ipynb), which demonstrates an assistant accomplishing a task by **writing code and executing it** in a sandbox."
+    "This section is based on [agentchat_oai_code_interpreter.ipynb](https://github.com/ag2ai/ag2/blob/main/notebook/agentchat_oai_code_interpreter.ipynb), which demonstrates an assistant accomplishing a task by **writing code and executing it** in a sandbox."
    ]
   },
   {
@@ -844,15 +844,15 @@
    "metadata": {},
    "source": [
     "## Teachable OpenAI Assistant with Retrieval\n",
-    "This section is based on [agentchat_oai_assistant_retrieval.ipynb](https://github.com/microsoft/autogen/blob/teach_cap/notebook/agentchat_oai_assistant_retrieval.ipynb), which demonstrates an assistant accomplishing a task through **retrieval augmented generation (RAG)**."
+    "This section is based on [agentchat_oai_assistant_retrieval.ipynb](https://github.com/ag2ai/ag2/blob/main/notebook/agentchat_oai_assistant_retrieval.ipynb), which demonstrates an assistant accomplishing a task through **retrieval augmented generation (RAG)**."
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
     "### Create the OpenAI Assistant with retrieval as a tool\n",
-    "For this example, first upload the [conversable_agent.py](https://github.com/microsoft/autogen/blob/main/autogen/agentchat/conversable_agent.py) file to your OpenAI API account. This can be done manually through the [website](https://platform.openai.com/assistants). Then find the uploaded File ID on the [Files page](https://platform.openai.com/files), and paste that ID into the `file_ids` list in the code below."
+    "For this example, first upload the [conversable_agent.py](https://github.com/ag2ai/ag2/blob/main/autogen/agentchat/conversable_agent.py) file to your OpenAI API account. This can be done manually through the [website](https://platform.openai.com/assistants). Then find the uploaded File ID on the [Files page](https://platform.openai.com/files), and paste that ID into the `file_ids` list in the code below."
    ]
   },
   {

notebook/agentchat_teaching.ipynb

@@ -12,7 +12,7 @@
     "AutoGen offers conversable agents powered by LLMs, tools, or humans, which can be used to perform tasks collectively via automated chat. This framework makes it easy to build many advanced applications of LLMs.\n",
     "Please find documentation about this feature [here](https://docs.ag2.ai/docs/Use-Cases/agent_chat).\n",
     "\n",
-    "This notebook demonstrates how AutoGen enables a user to teach AI new skills via natural agent interactions, without requiring knowledge of programming language. It is modified based on https://github.com/ag2ai/FLAML/blob/evaluation/notebook/research_paper/teaching.ipynb and https://github.com/ag2ai/FLAML/blob/evaluation/notebook/research_paper/teaching_recipe_reuse.ipynb.\n",
+    "This notebook demonstrates how AutoGen enables a user to teach AI new skills via natural agent interactions, without requiring knowledge of programming language. It is modified based on https://github.com/microsoft/FLAML/blob/evaluation/evaluation/research_paper/teaching.ipynb and https://github.com/microsoft/FLAML/blob/evaluation/evaluation/research_paper/teaching_recipe_reuse.ipynb.\n",
     "\n",
     "## Requirements\n",
     "\n",

notebook/agentchat_web_info.ipynb

@@ -108,7 +108,7 @@
     "]\n",
     "```\n",
     "\n",
-    "You can set the value of config_list in any way you prefer. Please refer to this [notebook](https://github.com/ag2ai/ag2/blob/main/notebook/oai_openai_utils.ipynb) for full code examples of the different methods."
+    "You can set the value of config_list in any way you prefer. Please refer to this [User Guide](https://docs.ag2.ai/docs/topics/llm_configuration) for full code examples of the different methods."
    ]
   },
   {