Skip to content

Commit 014e8a8

Browse files
Updating docs to work in new developer hub
Co-authored-by: Logan Markewich <[email protected]>
1 parent 1d270ef commit 014e8a8

File tree

193 files changed

+2449
-2018
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

193 files changed

+2449
-2018
lines changed

docs/docs/CHANGELOG.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
sidebar:
3+
order: 7
4+
---
5+
16
# ChangeLog
27

38
## [2025-09-15]
@@ -9824,8 +9829,8 @@ Last patch before v0.10!
98249829

98259830
- Change `BaseOpenAIAgent` to use `llama_index.llms.OpenAI`. Adjust `chat_history` to use `List[ChatMessage]]` as type.
98269831
- Remove (previously deprecated) `llama_index.langchain_helpers.chain_wrapper` module.
9827-
- Remove (previously deprecated) `llama_index.token_counter.token_counter` module. See [migration guide](/how_to/callbacks/token_counting_migration.html) for more details on new callback based token counting.
9828-
- Remove `ChatGPTLLMPredictor` and `HuggingFaceLLMPredictor`. See [migration guide](/how_to/customization/llms_migration_guide.html) for more details on replacements.
9832+
- Remove (previously deprecated) `llama_index.token_counter.token_counter` module. See [migration guide](/python/framework/module_guides/observability/callbacks/token_counting_migration/) for more details on new callback based token counting.
9833+
- Remove `ChatGPTLLMPredictor` and `HuggingFaceLLMPredictor`.
98299834
- Remove support for setting `cache` via `LLMPredictor` constructor.
98309835
- Update `BaseChatEngine` interface:
98319836
- adjust `chat_history` to use `List[ChatMessage]]` as type

docs/docs/_meta.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
collapsed: true

docs/docs/api_reference/instrumentation/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
LlamaIndex contains a simple instrumentation framework that allows you to
44
observe events and spans happening in the framework.
55

6-
- [Event Handlers](./event_handlers.md)
7-
- [Event Types](./event_types.md)
8-
- [Span Handlers](./span_handlers.md)
9-
- [Span Types](./span_types.md)
6+
- [Event Handlers](/python/framework/api_reference/instrumentation/event_handlers)
7+
- [Event Types](/python/framework/api_reference/instrumentation/event_types)
8+
- [Span Handlers](/python/framework/api_reference/instrumentation/span_handlers)
9+
- [Span Types](/python/framework/api_reference/instrumentation/span_types)

docs/docs/changes/_meta.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
hidden: true

docs/docs/changes/deprecated_terms.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ This has been renamed to `VectorStoreIndex`, as well as unifying all vector inde
1010

1111
Please see the following links for more details on usage.
1212

13-
- [Index Usage Pattern](../module_guides/evaluating/usage_pattern.md)
14-
- [Vector Store Guide](../module_guides/indexing/vector_store_guide.ipynb)
15-
- [Vector Store Integrations](../community/integrations/vector_stores.md)
13+
- [Index Usage Pattern](/python/framework/module_guides/evaluating/usage_pattern)
14+
- [Vector Store Guide](/python/framework/module_guides/indexing/vector_store_guide)
15+
- [Vector Store Integrations](/python/framework/community/integrations/vector_stores)
1616

1717
## GPTVectorStoreIndex
1818

1919
This has been renamed to `VectorStoreIndex`, but it is only a cosmetic change. Please see the following links for more details on usage.
2020

21-
- [Index Usage Pattern](../module_guides/evaluating/usage_pattern.md)
22-
- [Vector Store Guide](../module_guides/indexing/vector_store_guide.ipynb)
23-
- [Vector Store Integrations](../community/integrations/vector_stores.md)
21+
- [Index Usage Pattern](/python/framework/module_guides/evaluating/usage_pattern)
22+
- [Vector Store Guide](/python/framework/module_guides/indexing/vector_store_guide)
23+
- [Vector Store Integrations](/python/framework/community/integrations/vector_stores)
2424

2525
## LLMPredictor
2626

2727
The `LLMPredictor` object is no longer intended to be used by users. Instead, you can setup an LLM directly and pass it into the `Settings` or the interface using the LLM. The `LLM` class itself has similar attributes and methods as the `LLMPredictor`.
2828

29-
- [LLMs in LlamaIndex](../module_guides/models/llms.md)
30-
- [Setting LLMs in the Settings](../module_guides/supporting_modules/settings.md)
29+
- [LLMs in LlamaIndex](/python/framework/module_guides/models/llms)
30+
- [Setting LLMs in the Settings](/python/framework/module_guides/supporting_modules/settings)
3131

3232
## PromptHelper and max_input_size/
3333

@@ -37,31 +37,31 @@ The `PromptHelper` in general has been deprecated in favour of specifying parame
3737

3838
See the following links for more details.
3939

40-
- [Configuring settings in the Settings](../module_guides/supporting_modules/settings.md)
41-
- [Parsing Documents into Nodes](../module_guides/loading/node_parsers/index.md)
40+
- [Configuring settings in the Settings](/python/framework/module_guides/supporting_modules/settings)
41+
- [Parsing Documents into Nodes](/python/framework/module_guides/loading/node_parsers)
4242

4343
## ServiceContext
4444

4545
The `ServiceContext` object has been deprecated in favour of the `Settings` object.
4646

47-
- [Configuring settings in the Settings](../module_guides/supporting_modules/settings.md)
47+
- [Configuring settings in the Settings](/python/framework/module_guides/supporting_modules/settings)
4848

4949
## llama-index-legacy
5050

5151
The `llama-index-legacy` package has been deprecated and removed from the repository. Please see the latest getting started guide for the latest information and usage.
5252

53-
- [Getting Started](../getting_started/installation.md)
53+
- [Getting Started](/python/framework/getting_started/installation)
5454

5555
## AgentRunner/AgentWorker (and related classes)
5656

57-
The `AgentRunner` and `AgentWorker` classes have been deprecated in favour of [AgentWorkflow](../module_guides/deploying/agents/index.md) and [Workflows](../module_guides/workflow/index.md).
57+
The `AgentRunner` and `AgentWorker` classes have been deprecated in favour of [AgentWorkflow](/python/framework/module_guides/deploying/agents) and [Workflows](/python/framework/module_guides/workflow).
5858

5959
This includes the following deprecated classes:
6060

6161
- `AgentRunner`
6262
- `FunctionCallingAgent`
6363
- `FunctionCallingAgentWorker`
64-
- `llama_index.core.agent.ReActAgent` (use [llama_index.core.agent.workflow.ReActAgent](../module_guides/deploying/agents/index.md))
64+
- `llama_index.core.agent.ReActAgent` (use [llama_index.core.agent.workflow.ReActAgent](/python/framework/module_guides/deploying/agents))
6565
- `ReActAgentWorker`
6666
- `LATSAgentWorker`
6767
- `CoAAgentWorker`
@@ -76,7 +76,7 @@ This includes the following deprecated classes:
7676

7777
## QueryPipeline (and related classes)
7878

79-
QueryPipeline has been deprecated in favour of [Workflows](../module_guides/workflow/index.md).
79+
QueryPipeline has been deprecated in favour of [Workflows](/python/framework/module_guides/workflow).
8080

8181
This includes the following deprecated classes:
8282

docs/docs/community/_meta.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
label: Open Source Community
2+
order: 6
3+
collapsed: true

docs/docs/community/faq/_meta.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
label: FAQ

docs/docs/community/faq/chat_engines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99

1010
##### 1. How to make bot retain context while answering, Can I do that with LlamaIndex?
1111

12-
Yes you can, Llamaindex provides chat engines that you can use to retain context and answer as per the context. You can find more here [Chat Engines](../../module_guides/deploying/chat_engines/index.md).
12+
Yes you can, Llamaindex provides chat engines that you can use to retain context and answer as per the context. You can find more here [Chat Engines](/python/framework/module_guides/deploying/chat_engines).
1313

1414
---
1515

1616
##### 2. How to use Data Agent with Chat engine?
1717

18-
To use data Agents with Chat engine you have to set the chat mode while initializing the chat engine. Find more here [ Data Agents with Chat Engine](../../module_guides/deploying/chat_engines/usage_pattern.md#available-chat-modes)
18+
To use data Agents with Chat engine you have to set the chat mode while initializing the chat engine. Find more here [ Data Agents with Chat Engine](/python/framework/module_guides/deploying/chat_engines/usage_pattern#available-chat-modes)

docs/docs/community/faq/documents_and_nodes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@
1010

1111
##### 1. What is the default `chunk_size` of a Node object?
1212

13-
It's 1024 by default. If you want to customize the `chunk_size`, You can follow [Customizing Node](../../module_guides/loading/node_parsers/index.md#customization)
13+
It's 1024 by default. If you want to customize the `chunk_size`, You can follow [Customizing Node](/python/framework/module_guides/loading/node_parsers#customization)
1414

1515
---
1616

1717
##### 2. How to add information like name, url in a `Document` object?
1818

19-
You can customize the Document object and add extra info in the form of metadata. To know more on this follow [Customize Document](../../module_guides/loading/documents_and_nodes/usage_documents.md#customizing-documents).
19+
You can customize the Document object and add extra info in the form of metadata. To know more on this follow [Customize Document](/python/framework/module_guides/loading/documents_and_nodes/usage_documents#customizing-documents).
2020

2121
---
2222

2323
##### 3. How to update existing document in an Index?
2424

25-
You can update/delete existing document in an Index with the help of `doc_id`. You can add new document to an existing Index too. To know more check [Document Management](../../module_guides/indexing/document_management.md)
25+
You can update/delete existing document in an Index with the help of `doc_id`. You can add new document to an existing Index too. To know more check [Document Management](/python/framework/module_guides/indexing/document_management)
2626

2727
---

docs/docs/community/faq/embeddings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@
1111

1212
##### 1. How to use a custom/local embedding model?
1313

14-
To create your customized embedding class you can follow [Custom Embeddings](../../examples/embeddings/custom_embeddings.ipynb) guide.
14+
To create your customized embedding class you can follow [Custom Embeddings](/python/examples/embeddings/custom_embeddings) guide.
1515

1616
---
1717

1818
##### 2. How to use a local hugging face embedding model?
1919

20-
To use a local HuggingFace embedding model you can follow [Local Embeddings with HuggingFace](../../examples/embeddings/huggingface.ipynb) guide.
20+
To use a local HuggingFace embedding model you can follow [Local Embeddings with HuggingFace](/python/examples/embeddings/huggingface) guide.
2121

2222
---
2323

@@ -33,4 +33,4 @@ text_embedding = embed_model.get_text_embedding("YOUR_TEXT")
3333

3434
##### 4. How to use Huggingface Text-Embedding Inference with LlamaIndex?
3535

36-
To use HuggingFace Text-Embedding Inference you can follow [Text-Embedding-Inference](../../examples/embeddings/text_embedding_inference.ipynb) tutorial.
36+
To use HuggingFace Text-Embedding Inference you can follow [Text-Embedding-Inference](/python/examples/embeddings/text_embedding_inference) tutorial.

0 commit comments

Comments
 (0)