diff --git a/.changeset/four-jobs-play.md b/.changeset/four-jobs-play.md deleted file mode 100644 index 4cd6523835dda1ec464fa4b17c95daf45a1494ae..0000000000000000000000000000000000000000 --- a/.changeset/four-jobs-play.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"create-llama": patch ---- - -- Added option to create a new project based on community templates -- Added OpenAI model selector for NextJS projects -- Added GPT4 Vision support (and file upload) diff --git a/.github/ISSUE_TEMPLATE/bugfix.yml b/.github/ISSUE_TEMPLATE/bugfix.yml index bb8c310bae44b3d4fa9b1f4d7e9eecf613b47262..0c6dc14985689a23519f51baff960ac3dc82267e 100644 --- a/.github/ISSUE_TEMPLATE/bugfix.yml +++ b/.github/ISSUE_TEMPLATE/bugfix.yml @@ -1,6 +1,6 @@ name: Bugfix title: "" -description: Write something like "We notice ... behavior when ... happens instead of ..."" +description: Write something like "We notice ... behavior when ... happens instead of ..." If you would like to use sweep.dev prefix with "Sweep:" body: - type: textarea id: description diff --git a/apps/docs/docusaurus.config.js b/apps/docs/docusaurus.config.js index 8e3495e2f2b03b3edd55779a0cb5689a7a251618..35cbe5aa02425e535859e7c4812ede9dabf2dc44 100644 --- a/apps/docs/docusaurus.config.js +++ b/apps/docs/docusaurus.config.js @@ -29,7 +29,7 @@ const config = { // to replace "en" with "zh-Hans". i18n: { defaultLocale: "en", - locales: ["en"], + locales: ["en", "fr", "zh-Hans"], }, presets: [ @@ -71,6 +71,10 @@ const config = { position: "left", label: "Docs", }, + { + type: "localeDropdown", + position: "left", + }, { href: "https://github.com/run-llama/LlamaIndexTS", label: "GitHub", diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/_static b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/_static new file mode 120000 index 0000000000000000000000000000000000000000..7fed3d2ad2de02f9861566b4144af31090fef807 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/_static @@ -0,0 +1 @@ +../../../../docs/_static \ No newline at end of file diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/_category_.yml b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..79eb4b8a2939888be2393145205ffe6bc5fea186 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/_category_.yml @@ -0,0 +1,2 @@ +label: "API" +position: 6 \ No newline at end of file diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Anthropic.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Anthropic.md new file mode 100644 index 0000000000000000000000000000000000000000..56ab22c9d134463fcb97f9b1032259949c78857c --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Anthropic.md @@ -0,0 +1,318 @@ +--- +id: "Anthropic" +title: "Class: Anthropic" +sidebar_label: "Anthropic" +sidebar_position: 0 +custom_edit_url: null +--- + +Anthropic LLM implementation + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new Anthropic**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------- | +| `init?` | `Partial`<[`Anthropic`](Anthropic.md)\> | + +#### Defined in + +[packages/core/src/llm/LLM.ts:667](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L667) + +## Properties + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:660](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L660) + +--- + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:665](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L665) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` = `true` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:651](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L651) + +--- + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:661](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L661) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:657](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L657) + +--- + +### model + +• **model**: `"claude-2"` \| `"claude-instant-1"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:654](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L654) + +--- + +### session + +• **session**: `AnthropicSession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:663](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L663) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:655](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L655) + +--- + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:662](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L662) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:656](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L656) + +## Accessors + +### metadata + +• `get` **metadata**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :----------------------------------- | +| `contextWindow` | `number` | +| `maxTokens` | `undefined` \| `number` | +| `model` | `"claude-2"` \| `"claude-instant-1"` | +| `temperature` | `number` | +| `tokenizer` | `undefined` | +| `topP` | `number` | + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:691](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L691) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:719](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L719) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:776](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L776) + +--- + +### mapMessagesToPrompt + +▸ **mapMessagesToPrompt**(`messages`): `string` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:702](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L702) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`messages`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:751](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L751) + +--- + +### streamComplete + +▸ `Protected` **streamComplete**(`prompt`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `prompt` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:794](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L794) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:687](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L687) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md new file mode 100644 index 0000000000000000000000000000000000000000..0743da72baded5149a8bf33820769f826f576e4b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md @@ -0,0 +1,289 @@ +--- +id: "BaseDocumentStore" +title: "Class: BaseDocumentStore" +sidebar_label: "BaseDocumentStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Constructors + +### constructor + +• **new BaseDocumentStore**() + +## Methods + +### addDocuments + +▸ `Abstract` **addDocuments**(`docs`, `allowUpdate`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------- | +| `docs` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | +| `allowUpdate` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L27) + +--- + +### deleteDocument + +▸ `Abstract` **deleteDocument**(`docId`, `raiseError`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----------- | :-------- | +| `docId` | `string` | +| `raiseError` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L34) + +--- + +### deleteRefDoc + +▸ `Abstract` **deleteRefDoc**(`refDocId`, `raiseError`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----------- | :-------- | +| `refDocId` | `string` | +| `raiseError` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L48) + +--- + +### docs + +▸ `Abstract` **docs**(): `Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Returns + +`Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L25) + +--- + +### documentExists + +▸ `Abstract` **documentExists**(`docId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L36) + +--- + +### getAllRefDocInfo + +▸ `Abstract` **getAllRefDocInfo**(): `Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Returns + +`Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L44) + +--- + +### getDocument + +▸ `Abstract` **getDocument**(`docId`, `raiseError`): `Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | +| :----------- | :-------- | +| `docId` | `string` | +| `raiseError` | `boolean` | + +#### Returns + +`Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L29) + +--- + +### getDocumentHash + +▸ `Abstract` **getDocumentHash**(`docId`): `Promise`<`undefined` \| `string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`undefined` \| `string`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L41) + +--- + +### getNode + +▸ **getNode**(`nodeId`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `nodeId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L57) + +--- + +### getNodeDict + +▸ **getNodeDict**(`nodeIdDict`): `Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `nodeIdDict` | `Object` | + +#### Returns + +`Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L65) + +--- + +### getNodes + +▸ **getNodes**(`nodeIds`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------- | :------------ | +| `nodeIds` | `string`[] | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L51) + +--- + +### getRefDocInfo + +▸ `Abstract` **getRefDocInfo**(`refDocId`): `Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L46) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `void` + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------------- | +| `persistPath` | `string` | `defaultPersistPath` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L17) + +--- + +### setDocumentHash + +▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `docId` | `string` | +| `docHash` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L39) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseEmbedding.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..dba9bc971d9bb8b5c09b97b87b67943e4d8925b4 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseEmbedding.md @@ -0,0 +1,83 @@ +--- +id: "BaseEmbedding" +title: "Class: BaseEmbedding" +sidebar_label: "BaseEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- **`BaseEmbedding`** + + ↳ [`MultiModalEmbedding`](MultiModalEmbedding.md) + + ↳ [`OpenAIEmbedding`](OpenAIEmbedding.md) + +## Constructors + +### constructor + +• **new BaseEmbedding**() + +## Methods + +### getQueryEmbedding + +▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/types.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L23) + +--- + +### getTextEmbedding + +▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/types.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L22) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseInMemoryKVStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseInMemoryKVStore.md new file mode 100644 index 0000000000000000000000000000000000000000..e7d46fdd66f378e65ed7866e62f3598ab89b0451 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseInMemoryKVStore.md @@ -0,0 +1,164 @@ +--- +id: "BaseInMemoryKVStore" +title: "Class: BaseInMemoryKVStore" +sidebar_label: "BaseInMemoryKVStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseKVStore`](BaseKVStore.md) + + ↳ **`BaseInMemoryKVStore`** + +## Constructors + +### constructor + +• **new BaseInMemoryKVStore**() + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[constructor](BaseKVStore.md#constructor) + +## Methods + +### delete + +▸ `Abstract` **delete**(`key`, `collection?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[delete](BaseKVStore.md#delete) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L14) + +--- + +### get + +▸ `Abstract` **get**(`key`, `collection?`): `Promise`<`StoredValue`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`StoredValue`\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[get](BaseKVStore.md#get) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L12) + +--- + +### getAll + +▸ `Abstract` **getAll**(`collection?`): `Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `collection?` | `string` | + +#### Returns + +`Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[getAll](BaseKVStore.md#getall) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L13) + +--- + +### persist + +▸ `Abstract` **persist**(`persistPath`, `fs?`): `void` + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L18) + +--- + +### put + +▸ `Abstract` **put**(`key`, `val`, `collection?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------- | +| `key` | `string` | +| `val` | `Record`<`string`, `any`\> | +| `collection?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[put](BaseKVStore.md#put) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L7) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`): [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `persistPath` | `string` | + +#### Returns + +[`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L19) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseIndex.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..ae296c1bf7f913ff0888859afb9e5c7f9a493d67 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseIndex.md @@ -0,0 +1,218 @@ +--- +id: "BaseIndex" +title: "Class: BaseIndex<T>" +sidebar_label: "BaseIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +Indexes are the data structure that we store our nodes and embeddings in so +they can be retrieved for our queries. + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Hierarchy + +- **`BaseIndex`** + + ↳ [`KeywordTableIndex`](KeywordTableIndex.md) + + ↳ [`SummaryIndex`](SummaryIndex.md) + + ↳ [`VectorStoreIndex`](VectorStoreIndex.md) + +## Constructors + +### constructor + +• **new BaseIndex**<`T`\>(`init`) + +#### Type parameters + +| Name | +| :--- | +| `T` | + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------ | +| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<`T`\> | + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:161](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L161) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L158) + +--- + +### indexStruct + +• **indexStruct**: `T` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L157) + +## Methods + +### asQueryEngine + +▸ `Abstract` **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L181) + +--- + +### asRetriever + +▸ `Abstract` **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `options?` | `any` | + +#### Returns + +[`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L174) + +--- + +### deleteRefDoc + +▸ `Abstract` **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------- | +| `refDocId` | `string` | +| `deleteFromDocStore?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L199) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ `Abstract` **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L198) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseIndexStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseIndexStore.md new file mode 100644 index 0000000000000000000000000000000000000000..cc4ce5d4412308facda82461d494eee30dd4d3ee --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseIndexStore.md @@ -0,0 +1,108 @@ +--- +id: "BaseIndexStore" +title: "Class: BaseIndexStore" +sidebar_label: "BaseIndexStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Constructors + +### constructor + +• **new BaseIndexStore**() + +## Methods + +### addIndexStruct + +▸ `Abstract` **addIndexStruct**(`indexStruct`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------ | +| `indexStruct` | [`IndexStruct`](IndexStruct.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/types.ts#L13) + +--- + +### deleteIndexStruct + +▸ `Abstract` **deleteIndexStruct**(`key`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `key` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/types.ts#L15) + +--- + +### getIndexStruct + +▸ `Abstract` **getIndexStruct**(`structId?`): `Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `structId?` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/types.ts#L17) + +--- + +### getIndexStructs + +▸ `Abstract` **getIndexStructs**(): `Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Returns + +`Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/types.ts#L11) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------------- | +| `persistPath` | `string` | `defaultPersistPath` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/types.ts#L19) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseKVStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseKVStore.md new file mode 100644 index 0000000000000000000000000000000000000000..5b0384f85e1d39ae63b8cb5b139052a94e2d3bed --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseKVStore.md @@ -0,0 +1,105 @@ +--- +id: "BaseKVStore" +title: "Class: BaseKVStore" +sidebar_label: "BaseKVStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- **`BaseKVStore`** + + ↳ [`SimpleKVStore`](SimpleKVStore.md) + + ↳ [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +## Constructors + +### constructor + +• **new BaseKVStore**() + +## Methods + +### delete + +▸ `Abstract` **delete**(`key`, `collection?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L14) + +--- + +### get + +▸ `Abstract` **get**(`key`, `collection?`): `Promise`<`StoredValue`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`StoredValue`\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L12) + +--- + +### getAll + +▸ `Abstract` **getAll**(`collection?`): `Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `collection?` | `string` | + +#### Returns + +`Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L13) + +--- + +### put + +▸ `Abstract` **put**(`key`, `val`, `collection?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------- | +| `key` | `string` | +| `val` | `Record`<`string`, `any`\> | +| `collection?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/types.ts#L7) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseNode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseNode.md new file mode 100644 index 0000000000000000000000000000000000000000..044b7b6586f7633c4fad4c434463fbb2bcf7852a --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/BaseNode.md @@ -0,0 +1,320 @@ +--- +id: "BaseNode" +title: "Class: BaseNode<T>" +sidebar_label: "BaseNode" +sidebar_position: 0 +custom_edit_url: null +--- + +Generic abstract class for retrievable nodes + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- **`BaseNode`** + + ↳ [`TextNode`](TextNode.md) + +## Constructors + +### constructor + +• **new BaseNode**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------ | +| `init?` | `Partial`<[`BaseNode`](BaseNode.md)<`T`\>\> | + +#### Defined in + +[packages/core/src/Node.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L60) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L51) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L50) + +--- + +### metadata + +• **metadata**: `T` + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L54) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L57) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ `Abstract` **generateHash**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L124) + +--- + +### getContent + +▸ `Abstract` **getContent**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L66) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ `Abstract` **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L67) + +--- + +### getType + +▸ `Abstract` **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Defined in + +[packages/core/src/Node.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L64) + +--- + +### setContent + +▸ `Abstract` **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :---- | +| `value` | `any` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/Node.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L68) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CallbackManager.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CallbackManager.md new file mode 100644 index 0000000000000000000000000000000000000000..c6d83278889e404670f461189e50ebc2e19220a3 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CallbackManager.md @@ -0,0 +1,83 @@ +--- +id: "CallbackManager" +title: "Class: CallbackManager" +sidebar_label: "CallbackManager" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- `CallbackManagerMethods` + +## Constructors + +### constructor + +• **new CallbackManager**(`handlers?`) + +#### Parameters + +| Name | Type | +| :---------- | :----------------------- | +| `handlers?` | `CallbackManagerMethods` | + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L86) + +## Properties + +### onLLMStream + +• `Optional` **onLLMStream**: (`params`: [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md)) => `void` \| `Promise`<`void`\> + +#### Type declaration + +▸ (`params`): `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------ | +| `params` | [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md) | + +##### Returns + +`void` \| `Promise`<`void`\> + +#### Implementation of + +CallbackManagerMethods.onLLMStream + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L83) + +--- + +### onRetrieve + +• `Optional` **onRetrieve**: (`params`: [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md)) => `void` \| `Promise`<`void`\> + +#### Type declaration + +▸ (`params`): `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------------ | +| `params` | [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md) | + +##### Returns + +`void` \| `Promise`<`void`\> + +#### Implementation of + +CallbackManagerMethods.onRetrieve + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L84) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ClipEmbedding.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ClipEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..f7ba81c2ea30f2271f797810287249ccd963b456 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ClipEmbedding.md @@ -0,0 +1,251 @@ +--- +id: "ClipEmbedding" +title: "Class: ClipEmbedding" +sidebar_label: "ClipEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`MultiModalEmbedding`](MultiModalEmbedding.md) + + ↳ **`ClipEmbedding`** + +## Constructors + +### constructor + +• **new ClipEmbedding**() + +#### Inherited from + +[MultiModalEmbedding](MultiModalEmbedding.md).[constructor](MultiModalEmbedding.md#constructor) + +## Properties + +### modelType + +• **modelType**: [`ClipEmbeddingModelType`](../enums/ClipEmbeddingModelType.md) = `ClipEmbeddingModelType.XENOVA_CLIP_VIT_BASE_PATCH16` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L11) + +--- + +### processor + +• `Private` **processor**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L15) + +--- + +### textModel + +• `Private` **textModel**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L17) + +--- + +### tokenizer + +• `Private` **tokenizer**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L14) + +--- + +### visionModel + +• `Private` **visionModel**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L16) + +## Methods + +### getImageEmbedding + +▸ **getImageEmbedding**(`image`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :--------------------------- | +| `image` | [`ImageType`](../#imagetype) | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[MultiModalEmbedding](MultiModalEmbedding.md).[getImageEmbedding](MultiModalEmbedding.md#getimageembedding) + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L61) + +--- + +### getImageEmbeddings + +▸ **getImageEmbeddings**(`images`): `Promise`<`number`[][]\> + +#### Parameters + +| Name | Type | +| :------- | :----------------------------- | +| `images` | [`ImageType`](../#imagetype)[] | + +#### Returns + +`Promise`<`number`[][]\> + +#### Inherited from + +[MultiModalEmbedding](MultiModalEmbedding.md).[getImageEmbeddings](MultiModalEmbedding.md#getimageembeddings) + +#### Defined in + +[packages/core/src/embeddings/MultiModalEmbedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/MultiModalEmbedding.ts#L11) + +--- + +### getProcessor + +▸ **getProcessor**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L27) + +--- + +### getQueryEmbedding + +▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[MultiModalEmbedding](MultiModalEmbedding.md).[getQueryEmbedding](MultiModalEmbedding.md#getqueryembedding) + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L76) + +--- + +### getTextEmbedding + +▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[MultiModalEmbedding](MultiModalEmbedding.md).[getTextEmbedding](MultiModalEmbedding.md#gettextembedding) + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L68) + +--- + +### getTextModel + +▸ **getTextModel**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L48) + +--- + +### getTokenizer + +▸ **getTokenizer**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L19) + +--- + +### getVisionModel + +▸ **getVisionModel**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L35) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Inherited from + +[MultiModalEmbedding](MultiModalEmbedding.md).[similarity](MultiModalEmbedding.md#similarity) + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CompactAndRefine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CompactAndRefine.md new file mode 100644 index 0000000000000000000000000000000000000000..c6fe9967861e032fb3f9fb0de313b5d260fd8c01 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CompactAndRefine.md @@ -0,0 +1,134 @@ +--- +id: "CompactAndRefine" +title: "Class: CompactAndRefine" +sidebar_label: "CompactAndRefine" +sidebar_position: 0 +custom_edit_url: null +--- + +CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks. + +## Hierarchy + +- [`Refine`](Refine.md) + + ↳ **`CompactAndRefine`** + +## Constructors + +### constructor + +• **new CompactAndRefine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`) + +#### Parameters + +| Name | Type | +| :---------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `textQATemplate?` | (`__namedParameters`: `Object`) => `string` | +| `refineTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +[Refine](Refine.md).[constructor](Refine.md#constructor) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L82) + +## Properties + +### refineTemplate + +• **refineTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +[Refine](Refine.md).[refineTemplate](Refine.md#refinetemplate) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L80) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[Refine](Refine.md).[serviceContext](Refine.md#servicecontext) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L78) + +--- + +### textQATemplate + +• **textQATemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +[Refine](Refine.md).[textQATemplate](Refine.md#textqatemplate) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:79](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L79) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `prevResponse?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Overrides + +[Refine](Refine.md).[getResponse](Refine.md#getresponse) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:185](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L185) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CondenseQuestionChatEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CondenseQuestionChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..ba58ab74889e4e24a333060c4b23bc61b984a026 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/CondenseQuestionChatEngine.md @@ -0,0 +1,170 @@ +--- +id: "CondenseQuestionChatEngine" +title: "Class: CondenseQuestionChatEngine" +sidebar_label: "CondenseQuestionChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorStoreIndex). +It does two steps on taking a user's chat message: first, it condenses the chat message +with the previous chat history into a question with more context. +Then, it queries the underlying Index using the new question with context and returns +the response. +CondenseQuestionChatEngine performs well when the input is primarily questions about the +underlying data. It performs less well when the chat messages are not questions about the +data, or are very referential to previous context. + +## Implements + +- [`ChatEngine`](../interfaces/ChatEngine.md) + +## Constructors + +### constructor + +• **new CondenseQuestionChatEngine**(`init`) + +#### Parameters + +| Name | Type | +| :---------------------------- | :---------------------------------------------------- | +| `init` | `Object` | +| `init.chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `init.condenseMessagePrompt?` | (`__namedParameters`: `Object`) => `string` | +| `init.queryEngine` | [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) | +| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Defined in + +[packages/core/src/ChatEngine.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L122) + +## Properties + +### chatHistory + +• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L118) + +--- + +### condenseMessagePrompt + +• **condenseMessagePrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ChatEngine.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L120) + +--- + +### queryEngine + +• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L117) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L119) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) + +#### Defined in + +[packages/core/src/ChatEngine.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L147) + +--- + +### condenseQuestion + +▸ `Private` **condenseQuestion**(`chatHistory`, `question`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `question` | `string` | + +#### Returns + +`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L136) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset) + +#### Defined in + +[packages/core/src/ChatEngine.ts:169](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L169) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ContextChatEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ContextChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..e40c90b8ff1bfcb1dffb978b36b55a91a45ea7f0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ContextChatEngine.md @@ -0,0 +1,142 @@ +--- +id: "ContextChatEngine" +title: "Class: ContextChatEngine" +sidebar_label: "ContextChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +ContextChatEngine uses the Index to get the appropriate context for each query. +The context is stored in the system prompt, and the chat history is preserved, +ideally allowing the appropriate context to be surfaced for each query. + +## Implements + +- [`ChatEngine`](../interfaces/ChatEngine.md) + +## Constructors + +### constructor + +• **new ContextChatEngine**(`init`) + +#### Parameters + +| Name | Type | +| :-------------------------- | :------------------------------------------------------------------ | +| `init` | `Object` | +| `init.chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `init.chatModel?` | [`LLM`](../interfaces/LLM.md) | +| `init.contextSystemPrompt?` | (`__namedParameters`: `Object`) => `string` | +| `init.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | +| `init.retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | + +#### Defined in + +[packages/core/src/ChatEngine.ts:243](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L243) + +## Properties + +### chatHistory + +• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L240) + +--- + +### chatModel + +• **chatModel**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L239) + +--- + +### contextGenerator + +• **contextGenerator**: [`ContextGenerator`](../interfaces/ContextGenerator.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:241](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L241) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) + +#### Defined in + +[packages/core/src/ChatEngine.ts:259](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L259) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset) + +#### Defined in + +[packages/core/src/ChatEngine.ts:336](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L336) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`message`, `chatHistory?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L300) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/DefaultContextGenerator.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/DefaultContextGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..a624630d2a53782e76c1089b5be2a7edf5b47e14 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/DefaultContextGenerator.md @@ -0,0 +1,119 @@ +--- +id: "DefaultContextGenerator" +title: "Class: DefaultContextGenerator" +sidebar_label: "DefaultContextGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`ContextGenerator`](../interfaces/ContextGenerator.md) + +## Constructors + +### constructor + +• **new DefaultContextGenerator**(`init`) + +#### Parameters + +| Name | Type | +| :-------------------------- | :------------------------------------------------------------------ | +| `init` | `Object` | +| `init.contextSystemPrompt?` | (`__namedParameters`: `Object`) => `string` | +| `init.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | +| `init.retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | + +#### Defined in + +[packages/core/src/ChatEngine.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L188) + +## Properties + +### contextSystemPrompt + +• **contextSystemPrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ChatEngine.ts:185](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L185) + +--- + +### nodePostprocessors + +• **nodePostprocessors**: [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L186) + +--- + +### retriever + +• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:184](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L184) + +## Methods + +### applyNodePostprocessors + +▸ `Private` **applyNodePostprocessors**(`nodes`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L199) + +--- + +### generate + +▸ **generate**(`message`, `parentEvent?`): `Promise`<[`Context`](../interfaces/Context.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `message` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`Context`](../interfaces/Context.md)\> + +#### Implementation of + +[ContextGenerator](../interfaces/ContextGenerator.md).[generate](../interfaces/ContextGenerator.md#generate) + +#### Defined in + +[packages/core/src/ChatEngine.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L206) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Document.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Document.md new file mode 100644 index 0000000000000000000000000000000000000000..b5823c19b45808fde265b41f6e5afc3c25a3bfb2 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Document.md @@ -0,0 +1,504 @@ +--- +id: "Document" +title: "Class: Document<T>" +sidebar_label: "Document" +sidebar_position: 0 +custom_edit_url: null +--- + +A document is just a special text node with a docId. + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`TextNode`](TextNode.md)<`T`\> + + ↳ **`Document`** + +## Constructors + +### constructor + +• **new Document**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------ | +| `init?` | `Partial`<[`Document`](Document.md)<`T`\>\> | + +#### Overrides + +[TextNode](TextNode.md).[constructor](TextNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:254](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L254) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[TextNode](TextNode.md).[embedding](TextNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[hash](TextNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[TextNode](TextNode.md).[id\_](TextNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L50) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[TextNode](TextNode.md).[metadata](TextNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[TextNode](TextNode.md).[relationships](TextNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[text](TextNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +TextNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getContent](TextNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getText](TextNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[TextNode](TextNode.md).[getType](TextNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:263](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L263) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[TextNode](TextNode.md).[setContent](TextNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[TextNode](TextNode.md).[toJSON](TextNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/HTMLReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/HTMLReader.md new file mode 100644 index 0000000000000000000000000000000000000000..f9bd7fa42bb8ca7c48bd8788a9f66bff1caded5e --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/HTMLReader.md @@ -0,0 +1,109 @@ +--- +id: "HTMLReader" +title: "Class: HTMLReader" +sidebar_label: "HTMLReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Extract the significant text from an arbitrary HTML document. +The contents of any head, script, style, and xml tags are removed completely. +The URLs for a[href] tags are extracted, along with the inner text of the tag. +All other tags are removed, and the inner text is kept intact. +Html entities (e.g., &) are not decoded. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new HTMLReader**() + +## Methods + +### getOptions + +▸ **getOptions**(): `Object` + +Wrapper for our configuration options passed to string-strip-html library + +#### Returns + +`Object` + +An object of options for the underlying library + +| Name | Type | +| :------------------------------- | :--------- | +| `skipHtmlDecoding` | `boolean` | +| `stripTogetherWithTheirContents` | `string`[] | + +**`See`** + +https://codsen.com/os/string-strip-html/examples + +#### Defined in + +[packages/core/src/readers/HTMLReader.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/HTMLReader.ts#L48) + +--- + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Public method for this reader. +Required by BaseReader interface. + +#### Parameters + +| Name | Type | Default value | Description | +| :----- | :-------------------------------------------------------- | :------------ | :------------------------------------------------- | +| `file` | `string` | `undefined` | Path/name of the file to be loaded. | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | fs wrapper interface for getting the file content. | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Promise<Document[]> A Promise object, eventually yielding zero or one Document parsed from the HTML content of the specified file. + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/HTMLReader.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/HTMLReader.ts#L21) + +--- + +### parseContent + +▸ **parseContent**(`html`, `options?`): `Promise`<`string`\> + +Wrapper for string-strip-html usage. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :---------------------------------------------- | +| `html` | `string` | Raw HTML content to be parsed. | +| `options` | `any` | An object of options for the underlying library | + +#### Returns + +`Promise`<`string`\> + +The HTML content, stripped of unwanted tags and attributes + +**`See`** + +getOptions + +#### Defined in + +[packages/core/src/readers/HTMLReader.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/HTMLReader.ts#L38) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/HistoryChatEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/HistoryChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..35b3d6a7a39b6d4c195087241539230d65428f44 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/HistoryChatEngine.md @@ -0,0 +1,120 @@ +--- +id: "HistoryChatEngine" +title: "Class: HistoryChatEngine" +sidebar_label: "HistoryChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +HistoryChatEngine is a ChatEngine that uses a `ChatHistory` object +to keeps track of chat's message history. +A `ChatHistory` object is passed as a parameter for each call to the `chat` method, +so the state of the chat engine is preserved between calls. +Optionally, a `ContextGenerator` can be used to generate an additional context for each call to `chat`. + +## Constructors + +### constructor + +• **new HistoryChatEngine**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------ | +| `init?` | `Partial`<[`HistoryChatEngine`](HistoryChatEngine.md)\> | + +#### Defined in + +[packages/core/src/ChatEngine.ts:381](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L381) + +## Properties + +### contextGenerator + +• `Optional` **contextGenerator**: [`ContextGenerator`](../interfaces/ContextGenerator.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:379](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L379) + +--- + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:378](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L378) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory`, `streaming?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory` | [`ChatHistory`](../interfaces/ChatHistory.md) | +| `streaming?` | `T` | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:386](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L386) + +--- + +### prepareRequestMessages + +▸ `Private` **prepareRequestMessages**(`message`, `chatHistory`): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory` | [`ChatHistory`](../interfaces/ChatHistory.md) | + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:433](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L433) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`message`, `chatHistory`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory` | [`ChatHistory`](../interfaces/ChatHistory.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:407](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L407) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ImageDocument.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ImageDocument.md new file mode 100644 index 0000000000000000000000000000000000000000..2f2e56d3073c5d6f8e392484b6dd69a6302748b4 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ImageDocument.md @@ -0,0 +1,518 @@ +--- +id: "ImageDocument" +title: "Class: ImageDocument<T>" +sidebar_label: "ImageDocument" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`ImageNode`](ImageNode.md)<`T`\> + + ↳ **`ImageDocument`** + +## Constructors + +### constructor + +• **new ImageDocument**<`T`\>(`init`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------------------- | +| `init` | [`ImageNodeConstructorProps`](../#imagenodeconstructorprops)<`T`\> | + +#### Overrides + +[ImageNode](ImageNode.md).[constructor](ImageNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:310](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L310) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[ImageNode](ImageNode.md).[embedding](ImageNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[ImageNode](ImageNode.md).[endCharIdx](ImageNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[ImageNode](ImageNode.md).[excludedEmbedMetadataKeys](ImageNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[ImageNode](ImageNode.md).[excludedLlmMetadataKeys](ImageNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[ImageNode](ImageNode.md).[hash](ImageNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[ImageNode](ImageNode.md).[id\_](ImageNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L50) + +--- + +### image + +• **image**: [`ImageType`](../#imagetype) + +#### Inherited from + +[ImageNode](ImageNode.md).[image](ImageNode.md#image) + +#### Defined in + +[packages/core/src/Node.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L297) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[ImageNode](ImageNode.md).[metadata](ImageNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[ImageNode](ImageNode.md).[metadataSeparator](ImageNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[ImageNode](ImageNode.md).[relationships](ImageNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[ImageNode](ImageNode.md).[startCharIdx](ImageNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[ImageNode](ImageNode.md).[text](ImageNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +ImageNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[ImageNode](ImageNode.md).[asRelatedNodeInfo](ImageNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[generateHash](ImageNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[getContent](ImageNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[ImageNode](ImageNode.md).[getEmbedding](ImageNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[getMetadataStr](ImageNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[ImageNode](ImageNode.md).[getNodeInfo](ImageNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[getText](ImageNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[ImageNode](ImageNode.md).[getType](ImageNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:318](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L318) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[ImageNode](ImageNode.md).[setContent](ImageNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[ImageNode](ImageNode.md).[toJSON](ImageNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ImageNode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ImageNode.md new file mode 100644 index 0000000000000000000000000000000000000000..be34dbe2b10461e22fdce4ca28b35af17d2582da --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ImageNode.md @@ -0,0 +1,516 @@ +--- +id: "ImageNode" +title: "Class: ImageNode<T>" +sidebar_label: "ImageNode" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`TextNode`](TextNode.md)<`T`\> + + ↳ **`ImageNode`** + + ↳↳ [`ImageDocument`](ImageDocument.md) + +## Constructors + +### constructor + +• **new ImageNode**<`T`\>(`init`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------------------- | +| `init` | [`ImageNodeConstructorProps`](../#imagenodeconstructorprops)<`T`\> | + +#### Overrides + +[TextNode](TextNode.md).[constructor](TextNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:299](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L299) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[TextNode](TextNode.md).[embedding](TextNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[hash](TextNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[TextNode](TextNode.md).[id\_](TextNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L50) + +--- + +### image + +• **image**: [`ImageType`](../#imagetype) + +#### Defined in + +[packages/core/src/Node.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L297) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[TextNode](TextNode.md).[metadata](TextNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[TextNode](TextNode.md).[relationships](TextNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[text](TextNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +TextNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getContent](TextNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getText](TextNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[TextNode](TextNode.md).[getType](TextNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:304](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L304) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[TextNode](TextNode.md).[setContent](TextNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[TextNode](TextNode.md).[toJSON](TextNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/InMemoryFileSystem.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/InMemoryFileSystem.md new file mode 100644 index 0000000000000000000000000000000000000000..1ede08f0d602baab8f4ae87a0b3aaac4ff9ac89c --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/InMemoryFileSystem.md @@ -0,0 +1,129 @@ +--- +id: "InMemoryFileSystem" +title: "Class: InMemoryFileSystem" +sidebar_label: "InMemoryFileSystem" +sidebar_position: 0 +custom_edit_url: null +--- + +A filesystem implementation that stores files in memory. + +## Implements + +- [`GenericFileSystem`](../interfaces/GenericFileSystem.md) + +## Constructors + +### constructor + +• **new InMemoryFileSystem**() + +## Properties + +### files + +• `Private` **files**: `Record`<`string`, `any`\> = `{}` + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L25) + +## Methods + +### access + +▸ **access**(`path`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[access](../interfaces/GenericFileSystem.md#access) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L38) + +--- + +### mkdir + +▸ **mkdir**(`path`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[mkdir](../interfaces/GenericFileSystem.md#mkdir) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L44) + +--- + +### readFile + +▸ **readFile**(`path`, `options?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[readFile](../interfaces/GenericFileSystem.md#readfile) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L31) + +--- + +### writeFile + +▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `content` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[writeFile](../interfaces/GenericFileSystem.md#writefile) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L27) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexDict.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexDict.md new file mode 100644 index 0000000000000000000000000000000000000000..424502663a7faeebd4e3dd7c538aec034530e02e --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexDict.md @@ -0,0 +1,161 @@ +--- +id: "IndexDict" +title: "Class: IndexDict" +sidebar_label: "IndexDict" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- [`IndexStruct`](IndexStruct.md) + + ↳ **`IndexDict`** + +## Constructors + +### constructor + +• **new IndexDict**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Inherited from + +[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### nodesDict + +• **nodesDict**: `Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> = `{}` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L46) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L17) + +--- + +### type + +• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.SIMPLE_DICT` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L47) + +## Methods + +### addNode + +▸ **addNode**(`node`, `textId?`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :----------------------------------------------------- | +| `node` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\> | +| `textId?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L56) + +--- + +### delete + +▸ **delete**(`nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L69) + +--- + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Overrides + +[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L49) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L61) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexList.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexList.md new file mode 100644 index 0000000000000000000000000000000000000000..d757693f46c309901497a1c8dc4be4a568c8f4cb --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexList.md @@ -0,0 +1,140 @@ +--- +id: "IndexList" +title: "Class: IndexList" +sidebar_label: "IndexList" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- [`IndexStruct`](IndexStruct.md) + + ↳ **`IndexList`** + +## Constructors + +### constructor + +• **new IndexList**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Inherited from + +[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### nodes + +• **nodes**: `string`[] = `[]` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L94) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L17) + +--- + +### type + +• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.LIST` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L95) + +## Methods + +### addNode + +▸ **addNode**(`node`): `void` + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------- | +| `node` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L97) + +--- + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L31) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L101) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexNode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7b521e9d4ffd9aacf72de11c53ca4240e8de8f7f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexNode.md @@ -0,0 +1,514 @@ +--- +id: "IndexNode" +title: "Class: IndexNode<T>" +sidebar_label: "IndexNode" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`TextNode`](TextNode.md)<`T`\> + + ↳ **`IndexNode`** + +## Constructors + +### constructor + +• **new IndexNode**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------- | +| `init?` | `Partial`<[`IndexNode`](IndexNode.md)<`T`\>\> | + +#### Overrides + +[TextNode](TextNode.md).[constructor](TextNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L236) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[TextNode](TextNode.md).[embedding](TextNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[hash](TextNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[TextNode](TextNode.md).[id\_](TextNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L50) + +--- + +### indexId + +• **indexId**: `string` = `""` + +#### Defined in + +[packages/core/src/Node.ts:234](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L234) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[TextNode](TextNode.md).[metadata](TextNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[TextNode](TextNode.md).[relationships](TextNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[text](TextNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +TextNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getContent](TextNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getText](TextNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[TextNode](TextNode.md).[getType](TextNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:245](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L245) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[TextNode](TextNode.md).[setContent](TextNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[TextNode](TextNode.md).[toJSON](TextNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexStruct.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexStruct.md new file mode 100644 index 0000000000000000000000000000000000000000..f2fdafdb05c459645670392214200ed024821300 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/IndexStruct.md @@ -0,0 +1,84 @@ +--- +id: "IndexStruct" +title: "Class: IndexStruct" +sidebar_label: "IndexStruct" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- **`IndexStruct`** + + ↳ [`IndexDict`](IndexDict.md) + + ↳ [`IndexList`](IndexList.md) + + ↳ [`KeywordTable`](KeywordTable.md) + +## Constructors + +### constructor + +• **new IndexStruct**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L17) + +## Methods + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L31) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L24) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTable.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTable.md new file mode 100644 index 0000000000000000000000000000000000000000..9feb9dd3f19932c9aad45a7256d232db45a1e236 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTable.md @@ -0,0 +1,162 @@ +--- +id: "KeywordTable" +title: "Class: KeywordTable" +sidebar_label: "KeywordTable" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- [`IndexStruct`](IndexStruct.md) + + ↳ **`KeywordTable`** + +## Constructors + +### constructor + +• **new KeywordTable**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Inherited from + +[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L17) + +--- + +### table + +• **table**: `Map`<`string`, `Set`<`string`\>\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L112) + +--- + +### type + +• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.KEYWORD_TABLE` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L113) + +## Methods + +### addNode + +▸ **addNode**(`keywords`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `keywords` | `string`[] | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L114) + +--- + +### deleteNode + +▸ **deleteNode**(`keywords`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `keywords` | `string`[] | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L123) + +--- + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L31) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L131) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableIndex.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..7f3f6a000ae0181ab522eef0798c6bbbc5d901ef --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableIndex.md @@ -0,0 +1,382 @@ +--- +id: "KeywordTableIndex" +title: "Class: KeywordTableIndex" +sidebar_label: "KeywordTableIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +The KeywordTableIndex, an index that extracts keywords from each Node and builds a mapping from each keyword to the corresponding Nodes of that keyword. + +## Hierarchy + +- [`BaseIndex`](BaseIndex.md)<[`KeywordTable`](KeywordTable.md)\> + + ↳ **`KeywordTableIndex`** + +## Constructors + +### constructor + +• **new KeywordTableIndex**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------ | +| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<[`KeywordTable`](KeywordTable.md)\> | + +#### Overrides + +[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L49) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L158) + +--- + +### indexStruct + +• **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L157) + +## Methods + +### asQueryEngine + +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | - | +| `options.preFilters?` | `unknown` | - | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L130) + +--- + +### asRetriever + +▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `options?` | `any` | + +#### Returns + +[`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L119) + +--- + +### deleteNode + +▸ **deleteNode**(`nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L224) + +--- + +### deleteNodes + +▸ **deleteNodes**(`nodeIds`, `deleteFromDocStore`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------- | :--------- | +| `nodeIds` | `string`[] | +| `deleteFromDocStore` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L242) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------- | +| `refDocId` | `string` | +| `deleteFromDocStore?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:256](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L256) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L214) + +--- + +### buildIndexFromNodes + +▸ `Static` **buildIndexFromNodes**(`nodes`, `docStore`, `serviceContext`): `Promise`<[`KeywordTable`](KeywordTable.md)\> + +Get keywords for nodes and place them into the index. + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | +| `docStore` | [`BaseDocumentStore`](BaseDocumentStore.md) | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +`Promise`<[`KeywordTable`](KeywordTable.md)\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L197) + +--- + +### extractKeywords + +▸ `Static` **extractKeywords**(`text`, `serviceContext`): `Promise`<`Set`<`string`\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------------------- | +| `text` | `string` | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +`Promise`<`Set`<`string`\>\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L145) + +--- + +### fromDocuments + +▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +High level API: split documents, get keywords, and build index. + +#### Parameters + +| Name | Type | +| :--------------------- | :------------------------------------------------------- | +| `documents` | [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] | +| `args` | `Object` | +| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | + +#### Returns + +`Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:164](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L164) + +--- + +### init + +▸ `Static` **init**(`options`): `Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :-------------------- | +| `options` | `KeywordIndexOptions` | + +#### Returns + +`Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L53) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableLLMRetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableLLMRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..ed8030fded5d56ac415581ba01daef0146f60fa0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableLLMRetriever.md @@ -0,0 +1,244 @@ +--- +id: "KeywordTableLLMRetriever" +title: "Class: KeywordTableLLMRetriever" +sidebar_label: "KeywordTableLLMRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseKeywordTableRetriever` + + ↳ **`KeywordTableLLMRetriever`** + +## Constructors + +### constructor + +• **new KeywordTableLLMRetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :------------------------------------------ | +| `«destructured»` | `Object` | +| › `index` | [`KeywordTableIndex`](KeywordTableIndex.md) | +| › `keywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | +| › `maxKeywordsPerQuery` | `number` | +| › `numChunksPerQuery` | `number` | +| › `queryKeywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +BaseKeywordTableRetriever.constructor + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L31) + +## Properties + +### docstore + +• `Protected` **docstore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +BaseKeywordTableRetriever.docstore + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L23) + +--- + +### index + +• `Protected` **index**: [`KeywordTableIndex`](KeywordTableIndex.md) + +#### Inherited from + +BaseKeywordTableRetriever.index + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L21) + +--- + +### indexStruct + +• `Protected` **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +BaseKeywordTableRetriever.indexStruct + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L22) + +--- + +### keywordExtractTemplate + +• `Protected` **keywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.keywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L28) + +--- + +### maxKeywordsPerQuery + +• `Protected` **maxKeywordsPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.maxKeywordsPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L26) + +--- + +### numChunksPerQuery + +• `Protected` **numChunksPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.numChunksPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L27) + +--- + +### queryKeywordExtractTemplate + +• `Protected` **queryKeywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.queryKeywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L29) + +--- + +### serviceContext + +• `Protected` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.serviceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L24) + +## Methods + +### getKeywords + +▸ **getKeywords**(`query`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Overrides + +BaseKeywordTableRetriever.getKeywords + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L88) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.getServiceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L81) + +--- + +### retrieve + +▸ **retrieve**(`query`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +BaseKeywordTableRetriever.retrieve + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableRAKERetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableRAKERetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..6324d5e39f30b7839287e0b2e595422506b9059d --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableRAKERetriever.md @@ -0,0 +1,244 @@ +--- +id: "KeywordTableRAKERetriever" +title: "Class: KeywordTableRAKERetriever" +sidebar_label: "KeywordTableRAKERetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseKeywordTableRetriever` + + ↳ **`KeywordTableRAKERetriever`** + +## Constructors + +### constructor + +• **new KeywordTableRAKERetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :------------------------------------------ | +| `«destructured»` | `Object` | +| › `index` | [`KeywordTableIndex`](KeywordTableIndex.md) | +| › `keywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | +| › `maxKeywordsPerQuery` | `number` | +| › `numChunksPerQuery` | `number` | +| › `queryKeywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +BaseKeywordTableRetriever.constructor + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L31) + +## Properties + +### docstore + +• `Protected` **docstore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +BaseKeywordTableRetriever.docstore + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L23) + +--- + +### index + +• `Protected` **index**: [`KeywordTableIndex`](KeywordTableIndex.md) + +#### Inherited from + +BaseKeywordTableRetriever.index + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L21) + +--- + +### indexStruct + +• `Protected` **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +BaseKeywordTableRetriever.indexStruct + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L22) + +--- + +### keywordExtractTemplate + +• `Protected` **keywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.keywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L28) + +--- + +### maxKeywordsPerQuery + +• `Protected` **maxKeywordsPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.maxKeywordsPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L26) + +--- + +### numChunksPerQuery + +• `Protected` **numChunksPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.numChunksPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L27) + +--- + +### queryKeywordExtractTemplate + +• `Protected` **queryKeywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.queryKeywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L29) + +--- + +### serviceContext + +• `Protected` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.serviceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L24) + +## Methods + +### getKeywords + +▸ **getKeywords**(`query`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Overrides + +BaseKeywordTableRetriever.getKeywords + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L114) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.getServiceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L81) + +--- + +### retrieve + +▸ **retrieve**(`query`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +BaseKeywordTableRetriever.retrieve + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableSimpleRetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableSimpleRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..98cdc198cf4cbab39d0b168e7bd4d147e14b2908 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/KeywordTableSimpleRetriever.md @@ -0,0 +1,244 @@ +--- +id: "KeywordTableSimpleRetriever" +title: "Class: KeywordTableSimpleRetriever" +sidebar_label: "KeywordTableSimpleRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseKeywordTableRetriever` + + ↳ **`KeywordTableSimpleRetriever`** + +## Constructors + +### constructor + +• **new KeywordTableSimpleRetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :------------------------------------------ | +| `«destructured»` | `Object` | +| › `index` | [`KeywordTableIndex`](KeywordTableIndex.md) | +| › `keywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | +| › `maxKeywordsPerQuery` | `number` | +| › `numChunksPerQuery` | `number` | +| › `queryKeywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +BaseKeywordTableRetriever.constructor + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L31) + +## Properties + +### docstore + +• `Protected` **docstore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +BaseKeywordTableRetriever.docstore + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L23) + +--- + +### index + +• `Protected` **index**: [`KeywordTableIndex`](KeywordTableIndex.md) + +#### Inherited from + +BaseKeywordTableRetriever.index + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L21) + +--- + +### indexStruct + +• `Protected` **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +BaseKeywordTableRetriever.indexStruct + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L22) + +--- + +### keywordExtractTemplate + +• `Protected` **keywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.keywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L28) + +--- + +### maxKeywordsPerQuery + +• `Protected` **maxKeywordsPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.maxKeywordsPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L26) + +--- + +### numChunksPerQuery + +• `Protected` **numChunksPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.numChunksPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L27) + +--- + +### queryKeywordExtractTemplate + +• `Protected` **queryKeywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.queryKeywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L29) + +--- + +### serviceContext + +• `Protected` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.serviceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L24) + +## Methods + +### getKeywords + +▸ **getKeywords**(`query`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Overrides + +BaseKeywordTableRetriever.getKeywords + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L105) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.getServiceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L81) + +--- + +### retrieve + +▸ **retrieve**(`query`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +BaseKeywordTableRetriever.retrieve + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/LLMQuestionGenerator.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/LLMQuestionGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..15528f30dff3e4235cdf9373938a057ade6215f5 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/LLMQuestionGenerator.md @@ -0,0 +1,98 @@ +--- +id: "LLMQuestionGenerator" +title: "Class: LLMQuestionGenerator" +sidebar_label: "LLMQuestionGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +LLMQuestionGenerator uses the LLM to generate new questions for the LLM using tools and a user query. + +## Implements + +- [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) + +## Constructors + +### constructor + +• **new LLMQuestionGenerator**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------ | +| `init?` | `Partial`<[`LLMQuestionGenerator`](LLMQuestionGenerator.md)\> | + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L34) + +## Properties + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L30) + +--- + +### outputParser + +• **outputParser**: [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\> + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L32) + +--- + +### prompt + +• **prompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L31) + +## Methods + +### generate + +▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------ | +| `tools` | [`ToolMetadata`](../interfaces/ToolMetadata.md)[] | +| `query` | `string` | + +#### Returns + +`Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Implementation of + +[BaseQuestionGenerator](../interfaces/BaseQuestionGenerator.md).[generate](../interfaces/BaseQuestionGenerator.md#generate) + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L40) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/LlamaDeuce.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/LlamaDeuce.md new file mode 100644 index 0000000000000000000000000000000000000000..a2e2943b0c50087bdd17ee323a92b07a9737b08c --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/LlamaDeuce.md @@ -0,0 +1,325 @@ +--- +id: "LlamaDeuce" +title: "Class: LlamaDeuce" +sidebar_label: "LlamaDeuce" +sidebar_position: 0 +custom_edit_url: null +--- + +Llama2 LLM implementation + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new LlamaDeuce**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------- | +| `init?` | `Partial`<[`LlamaDeuce`](LlamaDeuce.md)\> | + +#### Defined in + +[packages/core/src/llm/LLM.ts:434](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L434) + +## Properties + +### chatStrategy + +• **chatStrategy**: [`DeuceChatStrategy`](../enums/DeuceChatStrategy.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:427](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L427) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:432](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L432) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:430](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L430) + +--- + +### model + +• **model**: `"Llama-2-70b-chat-old"` \| `"Llama-2-70b-chat-4bit"` \| `"Llama-2-13b-chat-old"` \| `"Llama-2-13b-chat-4bit"` \| `"Llama-2-7b-chat-old"` \| `"Llama-2-7b-chat-4bit"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:426](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L426) + +--- + +### replicateSession + +• **replicateSession**: `ReplicateSession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:431](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L431) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:428](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L428) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:429](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L429) + +## Accessors + +### metadata + +• `get` **metadata**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contextWindow` | `number` | +| `maxTokens` | `undefined` \| `number` | +| `model` | `"Llama-2-70b-chat-old"` \| `"Llama-2-70b-chat-4bit"` \| `"Llama-2-13b-chat-old"` \| `"Llama-2-13b-chat-4bit"` \| `"Llama-2-7b-chat-old"` \| `"Llama-2-7b-chat-4bit"` | +| `temperature` | `number` | +| `tokenizer` | `undefined` | +| `topP` | `number` | + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:454](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L454) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `_parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :-------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `_parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:592](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L592) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:632](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L632) + +--- + +### mapMessageTypeA16Z + +▸ **mapMessageTypeA16Z**(`messageType`): `string` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------- | +| `messageType` | [`MessageType`](../#messagetype) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:501](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L501) + +--- + +### mapMessagesToPrompt + +▸ **mapMessagesToPrompt**(`messages`): `Object` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Object` + +| Name | Type | +| :------------- | :------- | +| `prompt` | `string` | +| `systemPrompt` | `any` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:465](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L465) + +--- + +### mapMessagesToPromptA16Z + +▸ **mapMessagesToPromptA16Z**(`messages`): `Object` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Object` + +| Name | Type | +| :------------- | :---------- | +| `prompt` | `string` | +| `systemPrompt` | `undefined` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:487](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L487) + +--- + +### mapMessagesToPromptMeta + +▸ **mapMessagesToPromptMeta**(`messages`, `opts?`): `Object` + +#### Parameters + +| Name | Type | +| :-------------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `opts?` | `Object` | +| `opts.replicate4Bit?` | `boolean` | +| `opts.withBos?` | `boolean` | +| `opts.withNewlines?` | `boolean` | + +#### Returns + +`Object` + +| Name | Type | +| :------------- | :------- | +| `prompt` | `string` | +| `systemPrompt` | `any` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:514](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L514) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:450](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L450) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MarkdownReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MarkdownReader.md new file mode 100644 index 0000000000000000000000000000000000000000..06ca25ae1d379ef32bd37401adaad9ce53d74b3a --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MarkdownReader.md @@ -0,0 +1,161 @@ +--- +id: "MarkdownReader" +title: "Class: MarkdownReader" +sidebar_label: "MarkdownReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Extract text from markdown files. +Returns dictionary with keys as headers and values as the text between headers. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new MarkdownReader**(`removeHyperlinks?`, `removeImages?`) + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------ | :-------- | :------------ | :---------------------------------------------- | +| `removeHyperlinks?` | `boolean` | `true` | Indicates whether hyperlinks should be removed. | +| `removeImages?` | `boolean` | `true` | Indicates whether images should be removed. | + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L19) + +## Properties + +### \_removeHyperlinks + +• `Private` **\_removeHyperlinks**: `boolean` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L12) + +--- + +### \_removeImages + +• `Private` **\_removeImages**: `boolean` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L13) + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----- | :-------------------------------------------------------- | :------------ | +| `file` | `string` | `undefined` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L90) + +--- + +### markdownToTups + +▸ **markdownToTups**(`markdownText`): `MarkdownTuple`[] + +Convert a markdown file to a dictionary. +The keys are the headers and the values are the text under each header. + +#### Parameters + +| Name | Type | Description | +| :------------- | :------- | :---------------------------- | +| `markdownText` | `string` | The markdown text to convert. | + +#### Returns + +`MarkdownTuple`[] + +- An array of tuples, where each tuple contains a header (or null) and its corresponding text. + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L30) + +--- + +### parseTups + +▸ **parseTups**(`content`): `MarkdownTuple`[] + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`MarkdownTuple`[] + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:79](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L79) + +--- + +### removeHyperlinks + +▸ **removeHyperlinks**(`content`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L74) + +--- + +### removeImages + +▸ **removeImages**(`content`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/MarkdownReader.ts#L69) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MongoDBAtlasVectorSearch.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MongoDBAtlasVectorSearch.md new file mode 100644 index 0000000000000000000000000000000000000000..87ea25ffd85a266b21243624b34bfbc0396d42d3 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MongoDBAtlasVectorSearch.md @@ -0,0 +1,223 @@ +--- +id: "MongoDBAtlasVectorSearch" +title: "Class: MongoDBAtlasVectorSearch" +sidebar_label: "MongoDBAtlasVectorSearch" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`VectorStore`](../interfaces/VectorStore.md) + +## Constructors + +### constructor + +• **new MongoDBAtlasVectorSearch**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :-------------------------------------------------------------------------------------------------------------------------- | +| `init` | `Partial`<[`MongoDBAtlasVectorSearch`](MongoDBAtlasVectorSearch.md)\> & { `collectionName`: `string` ; `dbName`: `string` } | + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L36) + +## Properties + +### collection + +• `Private` **collection**: `Collection`<`Document`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L34) + +--- + +### embeddingKey + +• **embeddingKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L29) + +--- + +### flatMetadata + +• **flatMetadata**: `boolean` = `true` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L25) + +--- + +### idKey + +• **idKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L30) + +--- + +### indexName + +• **indexName**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L28) + +--- + +### insertOptions + +• `Optional` **insertOptions**: `BulkWriteOptions` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L33) + +--- + +### metadataKey + +• **metadataKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L32) + +--- + +### mongodbClient + +• **mongodbClient**: `MongoClient` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L27) + +--- + +### storesText + +• **storesText**: `boolean` = `true` + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[storesText](../interfaces/VectorStore.md#storestext) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L24) + +--- + +### textKey + +• **textKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L31) + +## Accessors + +### client + +• `get` **client**(): `any` + +#### Returns + +`any` + +#### Implementation of + +VectorStore.client + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L103) + +## Methods + +### add + +▸ **add**(`nodes`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`string`[]\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[add](../interfaces/VectorStore.md#add) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L65) + +--- + +### delete + +▸ **delete**(`refDocId`, `deleteOptions?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `refDocId` | `string` | +| `deleteOptions?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[delete](../interfaces/VectorStore.md#delete) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L94) + +--- + +### query + +▸ **query**(`query`, `options?`): `Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------ | +| `query` | [`VectorStoreQuery`](../interfaces/VectorStoreQuery.md) | +| `options?` | `any` | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[query](../interfaces/VectorStore.md#query) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L107) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MultiModalEmbedding.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MultiModalEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..9974f6ec9887cee90ecd935f67fbd477137483be --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/MultiModalEmbedding.md @@ -0,0 +1,139 @@ +--- +id: "MultiModalEmbedding" +title: "Class: MultiModalEmbedding" +sidebar_label: "MultiModalEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseEmbedding`](BaseEmbedding.md) + + ↳ **`MultiModalEmbedding`** + + ↳↳ [`ClipEmbedding`](ClipEmbedding.md) + +## Constructors + +### constructor + +• **new MultiModalEmbedding**() + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor) + +## Methods + +### getImageEmbedding + +▸ `Abstract` **getImageEmbedding**(`images`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------- | :--------------------------- | +| `images` | [`ImageType`](../#imagetype) | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/MultiModalEmbedding.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/MultiModalEmbedding.ts#L9) + +--- + +### getImageEmbeddings + +▸ **getImageEmbeddings**(`images`): `Promise`<`number`[][]\> + +#### Parameters + +| Name | Type | +| :------- | :----------------------------- | +| `images` | [`ImageType`](../#imagetype)[] | + +#### Returns + +`Promise`<`number`[][]\> + +#### Defined in + +[packages/core/src/embeddings/MultiModalEmbedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/MultiModalEmbedding.ts#L11) + +--- + +### getQueryEmbedding + +▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding) + +#### Defined in + +[packages/core/src/embeddings/types.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L23) + +--- + +### getTextEmbedding + +▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding) + +#### Defined in + +[packages/core/src/embeddings/types.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L22) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[similarity](BaseEmbedding.md#similarity) + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/NotionReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/NotionReader.md new file mode 100644 index 0000000000000000000000000000000000000000..115787b99717d826fce38274433785810d7c366d --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/NotionReader.md @@ -0,0 +1,135 @@ +--- +id: "NotionReader" +title: "Class: NotionReader" +sidebar_label: "NotionReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Notion pages are retrieved recursively and converted to Document objects. +Notion Database can also be loaded, and [the serialization method can be customized](https://github.com/TomPenguin/notion-md-crawler/tree/main). + +[Note] To use this reader, must be created the Notion integration must be created in advance +Please refer to [this document](https://www.notion.so/help/create-integrations-with-the-notion-api) for details. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new NotionReader**(`options`) + +Constructor for the NotionReader class + +#### Parameters + +| Name | Type | Description | +| :-------- | :-------------------- | :----------------------------------- | +| `options` | `NotionReaderOptions` | Configuration options for the reader | + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/NotionReader.ts#L33) + +## Properties + +### crawl + +• `Private` **crawl**: (`rootPageId`: `string`) => `Promise`<`Pages`\> + +#### Type declaration + +▸ (`rootPageId`): `Promise`<`Pages`\> + +##### Parameters + +| Name | Type | +| :----------- | :------- | +| `rootPageId` | `string` | + +##### Returns + +`Promise`<`Pages`\> + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/NotionReader.ts#L27) + +## Methods + +### loadData + +▸ **loadData**(`rootPageId`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Loads recursively Notion pages and converts them to an array of Document objects + +#### Parameters + +| Name | Type | Description | +| :----------- | :------- | :---------------------- | +| `rootPageId` | `string` | The root Notion page ID | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +A Promise that resolves to an array of Document objects + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/NotionReader.ts#L63) + +--- + +### loadPages + +▸ **loadPages**(`rootPageId`): `Promise`<`Pages`\> + +Loads recursively the Notion page with the specified root page ID. + +#### Parameters + +| Name | Type | Description | +| :----------- | :------- | :---------------------- | +| `rootPageId` | `string` | The root Notion page ID | + +#### Returns + +`Promise`<`Pages`\> + +A Promise that resolves to a Pages object(Convertible with the `toDocuments` method) + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/NotionReader.ts#L54) + +--- + +### toDocuments + +▸ **toDocuments**(`pages`): [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] + +Converts Pages to an array of Document objects + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :-------------------------------------------------------- | +| `pages` | `Pages` | The Notion pages to convert (Return value of `loadPages`) | + +#### Returns + +[`Document`](Document.md)<[`Metadata`](../#metadata)\>[] + +An array of Document objects + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/NotionReader.ts#L42) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/OpenAI.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/OpenAI.md new file mode 100644 index 0000000000000000000000000000000000000000..afeb5f1e8b6585a694b92155a3ad81c2c97fd0e0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/OpenAI.md @@ -0,0 +1,338 @@ +--- +id: "OpenAI" +title: "Class: OpenAI" +sidebar_label: "OpenAI" +sidebar_position: 0 +custom_edit_url: null +--- + +OpenAI LLM implementation + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new OpenAI**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------------- | +| `init?` | `Partial`<[`OpenAI`](OpenAI.md)\> & { `azure?`: `AzureOpenAIConfig` } | + +#### Defined in + +[packages/core/src/llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L152) + +## Properties + +### additionalChatOptions + +• `Optional` **additionalChatOptions**: `Omit`<`Partial`<`ChatCompletionCreateParams`\>, `"model"` \| `"temperature"` \| `"max_tokens"` \| `"messages"` \| `"top_p"` \| `"streaming"`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L135) + +--- + +### additionalSessionOptions + +• `Optional` **additionalSessionOptions**: `Omit`<`Partial`<`ClientOptions`\>, `"apiKey"` \| `"timeout"` \| `"maxRetries"`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L145) + +--- + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L141) + +--- + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L150) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` = `true` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L128) + +--- + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L142) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L134) + +--- + +### model + +• **model**: `"gpt-3.5-turbo"` \| `"gpt-3.5-turbo-1106"` \| `"gpt-3.5-turbo-16k"` \| `"gpt-4"` \| `"gpt-4-32k"` \| `"gpt-4-1106-preview"` \| `"gpt-4-vision-preview"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L131) + +--- + +### session + +• **session**: `OpenAISession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L144) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:132](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L132) + +--- + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L143) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L133) + +## Accessors + +### metadata + +• `get` **metadata**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contextWindow` | `number` | +| `maxTokens` | `undefined` \| `number` | +| `model` | `"gpt-3.5-turbo"` \| `"gpt-3.5-turbo-1106"` \| `"gpt-3.5-turbo-16k"` \| `"gpt-4"` \| `"gpt-4-32k"` \| `"gpt-4-1106-preview"` \| `"gpt-4-vision-preview"` | +| `temperature` | `number` | +| `tokenizer` | [`CL100K_BASE`](../enums/Tokenizers.md#cl100k_base) | +| `topP` | `number` | + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L206) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:249](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L249) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:286](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L286) + +--- + +### mapMessageType + +▸ **mapMessageType**(`messageType`): `"function"` \| `"user"` \| `"assistant"` \| `"system"` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------- | +| `messageType` | [`MessageType`](../#messagetype) | + +#### Returns + +`"function"` \| `"user"` \| `"assistant"` \| `"system"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:232](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L232) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`messages`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L300) + +--- + +### streamComplete + +▸ `Protected` **streamComplete**(`query`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:362](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L362) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L217) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/OpenAIEmbedding.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/OpenAIEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..30055345ca1e32227082a951c571b0016b31f8d7 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/OpenAIEmbedding.md @@ -0,0 +1,187 @@ +--- +id: "OpenAIEmbedding" +title: "Class: OpenAIEmbedding" +sidebar_label: "OpenAIEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseEmbedding`](BaseEmbedding.md) + + ↳ **`OpenAIEmbedding`** + +## Constructors + +### constructor + +• **new OpenAIEmbedding**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------- | +| `init?` | `Partial`<[`OpenAIEmbedding`](OpenAIEmbedding.md)\> & { `azure?`: `AzureOpenAIConfig` } | + +#### Overrides + +[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L30) + +## Properties + +### additionalSessionOptions + +• `Optional` **additionalSessionOptions**: `Omit`<`Partial`<`ClientOptions`\>, `"apiKey"` \| `"timeout"` \| `"maxRetries"`\> + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L23) + +--- + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L20) + +--- + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L21) + +--- + +### model + +• **model**: [`TEXT_EMBED_ADA_002`](../enums/OpenAIEmbeddingModelType.md#text_embed_ada_002) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L17) + +--- + +### session + +• **session**: `OpenAISession` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L28) + +--- + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L22) + +## Methods + +### getOpenAIEmbedding + +▸ `Private` **getOpenAIEmbedding**(`input`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L76) + +--- + +### getQueryEmbedding + +▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L89) + +--- + +### getTextEmbedding + +▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L85) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[similarity](BaseEmbedding.md#similarity) + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PDFReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PDFReader.md new file mode 100644 index 0000000000000000000000000000000000000000..19b7fc8dcf88e0a610768e28e15156d596cfe712 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PDFReader.md @@ -0,0 +1,44 @@ +--- +id: "PDFReader" +title: "Class: PDFReader" +sidebar_label: "PDFReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read the text of a PDF + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new PDFReader**() + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----- | :-------------------------------------------------------- | :------------ | +| `file` | `string` | `undefined` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/PDFReader.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/PDFReader.ts#L11) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PGVectorStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PGVectorStore.md new file mode 100644 index 0000000000000000000000000000000000000000..2ef3016b9e19130a7f6bdcaffde1e799de3de4d7 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PGVectorStore.md @@ -0,0 +1,293 @@ +--- +id: "PGVectorStore" +title: "Class: PGVectorStore" +sidebar_label: "PGVectorStore" +sidebar_position: 0 +custom_edit_url: null +--- + +Provides support for writing and querying vector data in Postgres. + +## Implements + +- [`VectorStore`](../interfaces/VectorStore.md) + +## Constructors + +### constructor + +• **new PGVectorStore**() + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L40) + +## Properties + +### collection + +• `Private` **collection**: `string` = `""` + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L18) + +--- + +### db + +• `Optional` **db**: `Client` + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L38) + +--- + +### storesText + +• **storesText**: `boolean` = `true` + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[storesText](../interfaces/VectorStore.md#storestext) + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L16) + +## Methods + +### add + +▸ **add**(`embeddingResults`): `Promise`<`string`[]\> + +Adds vector record(s) to the table. +NOTE: Uses the collection property controlled by setCollection/getCollection. + +#### Parameters + +| Name | Type | Description | +| :----------------- | :------------------------------------------------------- | :-------------------------------------------------------------- | +| `embeddingResults` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | The Nodes to be inserted, optionally including metadata tuples. | + +#### Returns + +`Promise`<`string`[]\> + +A list of zero or more id values for the created records. + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[add](../interfaces/VectorStore.md#add) + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L144) + +--- + +### checkSchema + +▸ `Private` **checkSchema**(`db`): `Promise`<`Client`\> + +#### Parameters + +| Name | Type | +| :--- | :------- | +| `db` | `Client` | + +#### Returns + +`Promise`<`Client`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L90) + +--- + +### clearCollection + +▸ **clearCollection**(): `Promise`<`QueryResult`<`any`\>\> + +Delete all vector records for the specified collection. +NOTE: Uses the collection property controlled by setCollection/getCollection. + +#### Returns + +`Promise`<`QueryResult`<`any`\>\> + +The result of the delete query. + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L128) + +--- + +### client + +▸ **client**(): `Promise`<`Client`\> + +Connects to the database specified in environment vars. +This method also checks and creates the vector extension, +the destination table and indexes if not found. + +#### Returns + +`Promise`<`Client`\> + +A connection to the database, or the error encountered while connecting/setting up. + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[client](../interfaces/VectorStore.md#client) + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L119) + +--- + +### delete + +▸ **delete**(`refDocId`, `deleteKwargs?`): `Promise`<`void`\> + +Deletes a single record from the database by id. +NOTE: Uses the collection property controlled by setCollection/getCollection. + +#### Parameters + +| Name | Type | Description | +| :-------------- | :------- | :---------------------------------------------------- | +| `refDocId` | `string` | Unique identifier for the record to delete. | +| `deleteKwargs?` | `any` | Required by VectorStore interface. Currently ignored. | + +#### Returns + +`Promise`<`void`\> + +Promise that resolves if the delete query did not throw an error. + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[delete](../interfaces/VectorStore.md#delete) + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:196](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L196) + +--- + +### getCollection + +▸ **getCollection**(): `string` + +Getter for the collection property. +Using a collection allows for simple segregation of vector data, +e.g. by user, source, or access-level. +Leave/set blank to ignore the collection value when querying. + +#### Returns + +`string` + +The currently-set collection value. Default is empty string. + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L60) + +--- + +### getDb + +▸ `Private` **getDb**(): `Promise`<`Client`\> + +#### Returns + +`Promise`<`Client`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L64) + +--- + +### persist + +▸ **persist**(`persistPath`, `fs?`): `Promise`<`void`\> + +Required by VectorStore interface. Currently ignored. + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +Resolved Promise. + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:269](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L269) + +--- + +### query + +▸ **query**(`query`, `options?`): `Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +Query the vector store for the closest matching data to the query embeddings + +#### Parameters + +| Name | Type | Description | +| :--------- | :------------------------------------------------------ | :---------------------------------------------------- | +| `query` | [`VectorStoreQuery`](../interfaces/VectorStoreQuery.md) | The VectorStoreQuery to be used | +| `options?` | `any` | Required by VectorStore interface. Currently ignored. | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +Zero or more Document instances with data from the vector store. + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[query](../interfaces/VectorStore.md#query) + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L217) + +--- + +### setCollection + +▸ **setCollection**(`coll`): `void` + +Setter for the collection property. +Using a collection allows for simple segregation of vector data, +e.g. by user, source, or access-level. +Leave/set blank to ignore the collection value when querying. + +#### Parameters + +| Name | Type | Description | +| :----- | :------- | :----------------------- | +| `coll` | `string` | Name for the collection. | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/vectorStore/PGVectorStore.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/PGVectorStore.ts#L49) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PapaCSVReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PapaCSVReader.md new file mode 100644 index 0000000000000000000000000000000000000000..c06ec08497c851c4f07016bee2cb6ff5a6429dc3 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PapaCSVReader.md @@ -0,0 +1,105 @@ +--- +id: "PapaCSVReader" +title: "Class: PapaCSVReader" +sidebar_label: "PapaCSVReader" +sidebar_position: 0 +custom_edit_url: null +--- + +papaparse-based csv parser + +**`Implements`** + +BaseReader + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new PapaCSVReader**(`concatRows?`, `colJoiner?`, `rowJoiner?`, `papaConfig?`) + +Constructs a new instance of the class. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :--------------------------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `concatRows?` | `boolean` | `true` | whether to concatenate all rows into one document.If set to False, a Document will be created for each row.True by default. | +| `colJoiner?` | `string` | `", "` | - | +| `rowJoiner?` | `string` | `"\n"` | Separator to use for joining each row.Only used when `concat_rows=True`.Set to "\n" by default. | +| `papaConfig?` | `ParseConfig`<`any`, `undefined`\> | `undefined` | - | + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/CSVReader.ts#L23) + +## Properties + +### colJoiner + +• `Private` **colJoiner**: `string` + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/CSVReader.ts#L13) + +--- + +### concatRows + +• `Private` **concatRows**: `boolean` + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/CSVReader.ts#L12) + +--- + +### papaConfig + +• `Private` `Optional` **papaConfig**: `ParseConfig`<`any`, `undefined`\> + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/CSVReader.ts#L15) + +--- + +### rowJoiner + +• `Private` **rowJoiner**: `string` + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/CSVReader.ts#L14) + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Loads data from csv files + +#### Parameters + +| Name | Type | Default value | Description | +| :----- | :-------------------------------------------------------- | :------------ | :------------------------------------------- | +| `file` | `string` | `undefined` | The path to the file to load. | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | The file system to use for reading the file. | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/CSVReader.ts#L41) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Portkey.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Portkey.md new file mode 100644 index 0000000000000000000000000000000000000000..a17bad385b6b423ed3554af2206a748388ee72aa --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Portkey.md @@ -0,0 +1,261 @@ +--- +id: "Portkey" +title: "Class: Portkey" +sidebar_label: "Portkey" +sidebar_position: 0 +custom_edit_url: null +--- + +Unified language model interface + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new Portkey**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------- | +| `init?` | `Partial`<[`Portkey`](Portkey.md)\> | + +#### Defined in + +[packages/core/src/llm/LLM.ts:812](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L812) + +## Properties + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:805](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L805) + +--- + +### baseURL + +• `Optional` **baseURL**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:806](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L806) + +--- + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:810](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L810) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` = `true` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:803](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L803) + +--- + +### llms + +• `Optional` **llms**: `null` \| [`LLMOptions`] = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:808](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L808) + +--- + +### mode + +• `Optional` **mode**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:807](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L807) + +--- + +### session + +• **session**: `PortkeySession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:809](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L809) + +## Accessors + +### metadata + +• `get` **metadata**(): [`LLMMetadata`](../interfaces/LLMMetadata.md) + +#### Returns + +[`LLMMetadata`](../interfaces/LLMMetadata.md) + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:830](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L830) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`, `params?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | +| `params?` | `Record`<`string`, `any`\> | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:834](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L834) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:858](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L858) + +--- + +### streamChat + +▸ **streamChat**(`messages`, `parentEvent?`, `params?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `params?` | `Record`<`string`, `any`\> | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:873](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L873) + +--- + +### streamComplete + +▸ **streamComplete**(`query`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:920](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L920) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:826](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L826) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PromptHelper.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PromptHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..dce90c84ae488e8ca319df5d95a02e056c66d68b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/PromptHelper.md @@ -0,0 +1,198 @@ +--- +id: "PromptHelper" +title: "Class: PromptHelper" +sidebar_label: "PromptHelper" +sidebar_position: 0 +custom_edit_url: null +--- + +A collection of helper functions for working with prompts. + +## Constructors + +### constructor + +• **new PromptHelper**(`contextWindow?`, `numOutput?`, `chunkOverlapRatio?`, `chunkSizeLimit?`, `tokenizer?`, `separator?`) + +#### Parameters + +| Name | Type | Default value | +| :------------------ | :---------------------------------- | :---------------------------- | +| `contextWindow` | `number` | `DEFAULT_CONTEXT_WINDOW` | +| `numOutput` | `number` | `DEFAULT_NUM_OUTPUTS` | +| `chunkOverlapRatio` | `number` | `DEFAULT_CHUNK_OVERLAP_RATIO` | +| `chunkSizeLimit?` | `number` | `undefined` | +| `tokenizer?` | (`text`: `string`) => `Uint32Array` | `undefined` | +| `separator` | `string` | `" "` | + +#### Defined in + +[packages/core/src/PromptHelper.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L40) + +## Properties + +### chunkOverlapRatio + +• **chunkOverlapRatio**: `number` = `DEFAULT_CHUNK_OVERLAP_RATIO` + +#### Defined in + +[packages/core/src/PromptHelper.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L35) + +--- + +### chunkSizeLimit + +• `Optional` **chunkSizeLimit**: `number` + +#### Defined in + +[packages/core/src/PromptHelper.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L36) + +--- + +### contextWindow + +• **contextWindow**: `number` = `DEFAULT_CONTEXT_WINDOW` + +#### Defined in + +[packages/core/src/PromptHelper.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L33) + +--- + +### numOutput + +• **numOutput**: `number` = `DEFAULT_NUM_OUTPUTS` + +#### Defined in + +[packages/core/src/PromptHelper.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L34) + +--- + +### separator + +• **separator**: `string` = `" "` + +#### Defined in + +[packages/core/src/PromptHelper.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L38) + +--- + +### tokenizer + +• **tokenizer**: (`text`: `string`) => `Uint32Array` + +#### Type declaration + +▸ (`text`): `Uint32Array` + +##### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +##### Returns + +`Uint32Array` + +#### Defined in + +[packages/core/src/PromptHelper.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L37) + +## Methods + +### getAvailableChunkSize + +▸ `Private` **getAvailableChunkSize**(`prompt`, `numChunks?`, `padding?`): `number` + +Find the maximum size of each chunk given a prompt. + +#### Parameters + +| Name | Type | Default value | +| :---------- | :--------------------------------- | :------------ | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | `undefined` | +| `numChunks` | `number` | `1` | +| `padding` | `number` | `5` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/PromptHelper.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L76) + +--- + +### getAvailableContextSize + +▸ `Private` **getAvailableContextSize**(`prompt`): `number` + +Given a prompt, return the maximum size of the inputs to the prompt. + +#### Parameters + +| Name | Type | +| :------- | :--------------------------------- | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/PromptHelper.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L61) + +--- + +### getTextSplitterGivenPrompt + +▸ **getTextSplitterGivenPrompt**(`prompt`, `numChunks?`, `padding?`): [`SentenceSplitter`](SentenceSplitter.md) + +Creates a text splitter with the correct chunk sizes and overlaps given a prompt. + +#### Parameters + +| Name | Type | Default value | +| :---------- | :--------------------------------- | :---------------- | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | `undefined` | +| `numChunks` | `number` | `1` | +| `padding` | `number` | `DEFAULT_PADDING` | + +#### Returns + +[`SentenceSplitter`](SentenceSplitter.md) + +#### Defined in + +[packages/core/src/PromptHelper.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L99) + +--- + +### repack + +▸ **repack**(`prompt`, `textChunks`, `padding?`): `string`[] + +Repack resplits the strings based on the optimal text splitter. + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------- | :---------------- | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | `undefined` | +| `textChunks` | `string`[] | `undefined` | +| `padding` | `number` | `DEFAULT_PADDING` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/PromptHelper.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L120) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Refine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Refine.md new file mode 100644 index 0000000000000000000000000000000000000000..d4d7abcf2e71687e94f6ae10ea50fb053f8ca4d3 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Refine.md @@ -0,0 +1,167 @@ +--- +id: "Refine" +title: "Class: Refine" +sidebar_label: "Refine" +sidebar_position: 0 +custom_edit_url: null +--- + +A response builder that uses the query to ask the LLM generate a better response using multiple text chunks. + +## Hierarchy + +- **`Refine`** + + ↳ [`CompactAndRefine`](CompactAndRefine.md) + +## Implements + +- `BaseResponseBuilder` + +## Constructors + +### constructor + +• **new Refine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`) + +#### Parameters + +| Name | Type | +| :---------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `textQATemplate?` | (`__namedParameters`: `Object`) => `string` | +| `refineTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L82) + +## Properties + +### refineTemplate + +• **refineTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L80) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L78) + +--- + +### textQATemplate + +• **textQATemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:79](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L79) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `prevResponse?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +BaseResponseBuilder.getResponse + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L92) + +--- + +### giveResponseSingle + +▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `queryStr` | `string` | +| `textChunk` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L117) + +--- + +### refineResponseSingle + +▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `response` | `string` | +| `queryStr` | `string` | +| `textChunk` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L153) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Response.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Response.md new file mode 100644 index 0000000000000000000000000000000000000000..824cf01893f64bdb753e3a63a1a736994a1363e9 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/Response.md @@ -0,0 +1,74 @@ +--- +id: "Response" +title: "Class: Response" +sidebar_label: "Response" +sidebar_position: 0 +custom_edit_url: null +--- + +Respone is the output of a LLM + +## Constructors + +### constructor + +• **new Response**(`response`, `sourceNodes?`) + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------- | +| `response` | `string` | +| `sourceNodes?` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Defined in + +[packages/core/src/Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Response.ts#L10) + +## Properties + +### response + +• **response**: `string` + +#### Defined in + +[packages/core/src/Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Response.ts#L7) + +--- + +### sourceNodes + +• `Optional` **sourceNodes**: [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Response.ts#L8) + +## Methods + +### getFormattedSources + +▸ **getFormattedSources**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Response.ts#L15) + +--- + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Response.ts#L19) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ResponseSynthesizer.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ResponseSynthesizer.md new file mode 100644 index 0000000000000000000000000000000000000000..68e7404019d6a12697c4eea737de81c87cf65274 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/ResponseSynthesizer.md @@ -0,0 +1,80 @@ +--- +id: "ResponseSynthesizer" +title: "Class: ResponseSynthesizer" +sidebar_label: "ResponseSynthesizer" +sidebar_position: 0 +custom_edit_url: null +--- + +A ResponseSynthesizer is used to generate a response from a query and a list of nodes. + +## Constructors + +### constructor + +• **new ResponseSynthesizer**(`«destructured»?`) + +#### Parameters + +| Name | Type | +| :------------------- | :-------------------------------------------------- | +| `«destructured»` | `Object` | +| › `metadataMode?` | [`MetadataMode`](../enums/MetadataMode.md) | +| › `responseBuilder?` | `BaseResponseBuilder` | +| › `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:295](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L295) + +## Properties + +### metadataMode + +• **metadataMode**: [`MetadataMode`](../enums/MetadataMode.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:293](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L293) + +--- + +### responseBuilder + +• **responseBuilder**: `BaseResponseBuilder` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:291](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L291) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:292](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L292) + +## Methods + +### synthesize + +▸ **synthesize**(`query`, `nodesWithScore`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------------------------------- | +| `query` | `string` | +| `nodesWithScore` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`Response`](Response.md)\> + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:310](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L310) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/RetrieverQueryEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/RetrieverQueryEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..5c2cd2ca65f23a385953b1747132e76f8511114b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/RetrieverQueryEngine.md @@ -0,0 +1,140 @@ +--- +id: "RetrieverQueryEngine" +title: "Class: RetrieverQueryEngine" +sidebar_label: "RetrieverQueryEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +A query engine that uses a retriever to query an index and then synthesizes the response. + +## Implements + +- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +## Constructors + +### constructor + +• **new RetrieverQueryEngine**(`retriever`, `responseSynthesizer?`, `preFilters?`, `nodePostprocessors?`) + +#### Parameters + +| Name | Type | +| :--------------------- | :------------------------------------------------------------------ | +| `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | +| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | +| `preFilters?` | `unknown` | +| `nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | + +#### Defined in + +[packages/core/src/QueryEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L37) + +## Properties + +### nodePostprocessors + +• **nodePostprocessors**: [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] + +#### Defined in + +[packages/core/src/QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L34) + +--- + +### preFilters + +• `Optional` **preFilters**: `unknown` + +#### Defined in + +[packages/core/src/QueryEngine.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L35) + +--- + +### responseSynthesizer + +• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L33) + +--- + +### retriever + +• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L32) + +## Methods + +### applyNodePostprocessors + +▸ `Private` **applyNodePostprocessors**(`nodes`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L52) + +--- + +### query + +▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> + +Query the query engine and get a response. + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`Response`](Response.md)\> + +#### Implementation of + +[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query) + +#### Defined in + +[packages/core/src/QueryEngine.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L69) + +--- + +### retrieve + +▸ `Private` **retrieve**(`query`, `parentEvent`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------- | +| `query` | `string` | +| `parentEvent` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L59) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SentenceSplitter.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SentenceSplitter.md new file mode 100644 index 0000000000000000000000000000000000000000..91593eb573a3a19262e5903d71cebc1c23df1a08 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SentenceSplitter.md @@ -0,0 +1,271 @@ +--- +id: "SentenceSplitter" +title: "Class: SentenceSplitter" +sidebar_label: "SentenceSplitter" +sidebar_position: 0 +custom_edit_url: null +--- + +SentenceSplitter is our default text splitter that supports splitting into sentences, paragraphs, or fixed length chunks with overlap. + +One of the advantages of SentenceSplitter is that even in the fixed length chunks it will try to keep sentences together. + +## Constructors + +### constructor + +• **new SentenceSplitter**(`options?`) + +#### Parameters + +| Name | Type | +| :----------------------------- | :------------------------------------------------- | +| `options?` | `Object` | +| `options.chunkOverlap?` | `number` | +| `options.chunkSize?` | `number` | +| `options.chunkingTokenizerFn?` | (`text`: `string`) => `null` \| `RegExpMatchArray` | +| `options.paragraphSeparator?` | `string` | +| `options.splitLongSentences?` | `boolean` | +| `options.tokenizer?` | `any` | +| `options.tokenizerDecoder?` | `any` | + +#### Defined in + +[packages/core/src/TextSplitter.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L67) + +## Properties + +### chunkOverlap + +• `Private` **chunkOverlap**: `number` + +#### Defined in + +[packages/core/src/TextSplitter.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L60) + +--- + +### chunkSize + +• `Private` **chunkSize**: `number` + +#### Defined in + +[packages/core/src/TextSplitter.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L59) + +--- + +### chunkingTokenizerFn + +• `Private` **chunkingTokenizerFn**: (`text`: `string`) => `null` \| `RegExpMatchArray` + +#### Type declaration + +▸ (`text`): `null` \| `RegExpMatchArray` + +##### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +##### Returns + +`null` \| `RegExpMatchArray` + +#### Defined in + +[packages/core/src/TextSplitter.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L64) + +--- + +### paragraphSeparator + +• `Private` **paragraphSeparator**: `string` + +#### Defined in + +[packages/core/src/TextSplitter.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L63) + +--- + +### splitLongSentences + +• `Private` **splitLongSentences**: `boolean` + +#### Defined in + +[packages/core/src/TextSplitter.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L65) + +--- + +### tokenizer + +• `Private` **tokenizer**: `any` + +#### Defined in + +[packages/core/src/TextSplitter.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L61) + +--- + +### tokenizerDecoder + +• `Private` **tokenizerDecoder**: `any` + +#### Defined in + +[packages/core/src/TextSplitter.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L62) + +## Methods + +### combineTextSplits + +▸ **combineTextSplits**(`newSentenceSplits`, `effectiveChunkSize`): `TextSplit`[] + +#### Parameters + +| Name | Type | +| :------------------- | :----------- | +| `newSentenceSplits` | `SplitRep`[] | +| `effectiveChunkSize` | `number` | + +#### Returns + +`TextSplit`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L205) + +--- + +### getEffectiveChunkSize + +▸ `Private` **getEffectiveChunkSize**(`extraInfoStr?`): `number` + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `extraInfoStr?` | `string` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/TextSplitter.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L104) + +--- + +### getParagraphSplits + +▸ **getParagraphSplits**(`text`, `effectiveChunkSize?`): `string`[] + +#### Parameters + +| Name | Type | +| :-------------------- | :------- | +| `text` | `string` | +| `effectiveChunkSize?` | `number` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L121) + +--- + +### getSentenceSplits + +▸ **getSentenceSplits**(`text`, `effectiveChunkSize?`): `string`[] + +#### Parameters + +| Name | Type | +| :-------------------- | :------- | +| `text` | `string` | +| `effectiveChunkSize?` | `number` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L147) + +--- + +### processSentenceSplits + +▸ `Private` **processSentenceSplits**(`sentenceSplits`, `effectiveChunkSize`): `SplitRep`[] + +Splits sentences into chunks if necessary. + +This isn't great behavior because it can split down the middle of a +word or in non-English split down the middle of a Unicode codepoint +so the splitting is turned off by default. If you need it, please +set the splitLongSentences option to true. + +#### Parameters + +| Name | Type | +| :------------------- | :--------- | +| `sentenceSplits` | `string`[] | +| `effectiveChunkSize` | `number` | + +#### Returns + +`SplitRep`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L176) + +--- + +### splitText + +▸ **splitText**(`text`, `extraInfoStr?`): `string`[] + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `text` | `string` | +| `extraInfoStr?` | `string` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L297) + +--- + +### splitTextWithOverlaps + +▸ **splitTextWithOverlaps**(`text`, `extraInfoStr?`): `TextSplit`[] + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `text` | `string` | +| `extraInfoStr?` | `string` | + +#### Returns + +`TextSplit`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:269](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L269) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimilarityPostprocessor.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimilarityPostprocessor.md new file mode 100644 index 0000000000000000000000000000000000000000..2b43f3ca596fc326a8cbf80e2292777119c85283 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimilarityPostprocessor.md @@ -0,0 +1,62 @@ +--- +id: "SimilarityPostprocessor" +title: "Class: SimilarityPostprocessor" +sidebar_label: "SimilarityPostprocessor" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md) + +## Constructors + +### constructor + +• **new SimilarityPostprocessor**(`options?`) + +#### Parameters + +| Name | Type | +| :-------------------------- | :------- | +| `options?` | `Object` | +| `options.similarityCutoff?` | `number` | + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseNodePostprocessor.ts#L10) + +## Properties + +### similarityCutoff + +• `Optional` **similarityCutoff**: `number` + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseNodePostprocessor.ts#L8) + +## Methods + +### postprocessNodes + +▸ **postprocessNodes**(`nodes`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Implementation of + +[BaseNodePostprocessor](../interfaces/BaseNodePostprocessor.md).[postprocessNodes](../interfaces/BaseNodePostprocessor.md#postprocessnodes) + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseNodePostprocessor.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleChatEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..f355f86e9b0b410934e18a7978e92a6030b671a4 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleChatEngine.md @@ -0,0 +1,125 @@ +--- +id: "SimpleChatEngine" +title: "Class: SimpleChatEngine" +sidebar_label: "SimpleChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +SimpleChatEngine is the simplest possible chat engine. Useful for using your own custom prompts. + +## Implements + +- [`ChatEngine`](../interfaces/ChatEngine.md) + +## Constructors + +### constructor + +• **new SimpleChatEngine**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------------------- | +| `init?` | `Partial`<[`SimpleChatEngine`](SimpleChatEngine.md)\> | + +#### Defined in + +[packages/core/src/ChatEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L51) + +## Properties + +### chatHistory + +• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L48) + +--- + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L49) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) + +#### Defined in + +[packages/core/src/ChatEngine.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L56) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset) + +#### Defined in + +[packages/core/src/ChatEngine.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L101) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`message`, `chatHistory?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L78) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleChatHistory.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleChatHistory.md new file mode 100644 index 0000000000000000000000000000000000000000..af14120a6deba227610e8adf87ea279c2e8bf6a0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleChatHistory.md @@ -0,0 +1,145 @@ +--- +id: "SimpleChatHistory" +title: "Class: SimpleChatHistory" +sidebar_label: "SimpleChatHistory" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatHistory is used to keep the state of back and forth chat messages + +## Implements + +- [`ChatHistory`](../interfaces/ChatHistory.md) + +## Constructors + +### constructor + +• **new SimpleChatHistory**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------ | +| `init?` | `Partial`<[`SimpleChatHistory`](SimpleChatHistory.md)\> | + +#### Defined in + +[packages/core/src/ChatHistory.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L39) + +## Properties + +### messages + +• **messages**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[messages](../interfaces/ChatHistory.md#messages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L36) + +--- + +### messagesBefore + +• `Private` **messagesBefore**: `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L37) + +## Methods + +### addMessage + +▸ **addMessage**(`message`): `void` + +Adds a message to the chat history. + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------- | +| `message` | [`ChatMessage`](../interfaces/ChatMessage.md) | + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[addMessage](../interfaces/ChatHistory.md#addmessage) + +#### Defined in + +[packages/core/src/ChatHistory.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L44) + +--- + +### newMessages + +▸ **newMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +Returns the new messages since the last call to this function (or since calling the constructor) + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[newMessages](../interfaces/ChatHistory.md#newmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L56) + +--- + +### requestMessages + +▸ **requestMessages**(`transientMessages?`): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +Returns the messages that should be used as input to the LLM. + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `transientMessages?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[requestMessages](../interfaces/ChatHistory.md#requestmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L48) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[reset](../interfaces/ChatHistory.md#reset) + +#### Defined in + +[packages/core/src/ChatHistory.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L52) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleDirectoryReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleDirectoryReader.md new file mode 100644 index 0000000000000000000000000000000000000000..a2bf93cc4cfcc85db8e0685c8ca158405b081be5 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleDirectoryReader.md @@ -0,0 +1,88 @@ +--- +id: "SimpleDirectoryReader" +title: "Class: SimpleDirectoryReader" +sidebar_label: "SimpleDirectoryReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read all of the documents in a directory. +By default, supports the list of file types +in the FILE_EXT_TO_READER map. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new SimpleDirectoryReader**(`observer?`) + +#### Parameters + +| Name | Type | +| :---------- | :--------------- | +| `observer?` | `ReaderCallback` | + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L65) + +## Properties + +### observer + +• `Private` `Optional` **observer**: `ReaderCallback` + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L65) + +## Methods + +### doObserverCheck + +▸ `Private` **doObserverCheck**(`category`, `name`, `status`, `message?`): `boolean` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------ | +| `category` | `"file"` \| `"directory"` | +| `name` | `string` | +| `status` | `ReaderStatus` | +| `message?` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L135) + +--- + +### loadData + +▸ **loadData**(`«destructured»`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------------------------------------------------------------- | +| `«destructured»` | [`SimpleDirectoryReaderLoadDataProps`](../#simpledirectoryreaderloaddataprops) | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L67) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleDocumentStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleDocumentStore.md new file mode 100644 index 0000000000000000000000000000000000000000..8956cc937872e3cb1e23731907b26dea97fa387f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleDocumentStore.md @@ -0,0 +1,480 @@ +--- +id: "SimpleDocumentStore" +title: "Class: SimpleDocumentStore" +sidebar_label: "SimpleDocumentStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `KVDocumentStore` + + ↳ **`SimpleDocumentStore`** + +## Constructors + +### constructor + +• **new SimpleDocumentStore**(`kvStore?`, `namespace?`) + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------------- | +| `kvStore?` | [`SimpleKVStore`](SimpleKVStore.md) | +| `namespace?` | `string` | + +#### Overrides + +KVDocumentStore.constructor + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L19) + +## Properties + +### kvStore + +• `Private` **kvStore**: [`SimpleKVStore`](SimpleKVStore.md) + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L17) + +## Methods + +### addDocuments + +▸ **addDocuments**(`docs`, `allowUpdate?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------------------------------------------------- | :------------ | +| `docs` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | `undefined` | +| `allowUpdate` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.addDocuments + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L33) + +--- + +### deleteDocument + +▸ **deleteDocument**(`docId`, `raiseError?`, `removeRefDocNode?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :-------- | :------------ | +| `docId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | +| `removeRefDocNode` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.deleteDocument + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L131) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `raiseError?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `refDocId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.deleteRefDoc + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:148](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L148) + +--- + +### docs + +▸ **docs**(): `Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Returns + +`Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Inherited from + +KVDocumentStore.docs + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L24) + +--- + +### documentExists + +▸ **documentExists**(`docId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +KVDocumentStore.documentExists + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L105) + +--- + +### getAllRefDocInfo + +▸ **getAllRefDocInfo**(): `Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Returns + +`Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Inherited from + +KVDocumentStore.getAllRefDocInfo + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L93) + +--- + +### getDocument + +▸ **getDocument**(`docId`, `raiseError?`): `Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `docId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Inherited from + +KVDocumentStore.getDocument + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L73) + +--- + +### getDocumentHash + +▸ **getDocumentHash**(`docId`): `Promise`<`undefined` \| `string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`undefined` \| `string`\> + +#### Inherited from + +KVDocumentStore.getDocumentHash + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L174) + +--- + +### getNode + +▸ **getNode**(`nodeId`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `nodeId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Inherited from + +KVDocumentStore.getNode + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L57) + +--- + +### getNodeDict + +▸ **getNodeDict**(`nodeIdDict`): `Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `nodeIdDict` | `Object` | + +#### Returns + +`Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Inherited from + +KVDocumentStore.getNodeDict + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L65) + +--- + +### getNodes + +▸ **getNodes**(`nodeIds`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------- | :------------ | +| `nodeIds` | `string`[] | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +KVDocumentStore.getNodes + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L51) + +--- + +### getRefDocInfo + +▸ **getRefDocInfo**(`refDocId`): `Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Inherited from + +KVDocumentStore.getRefDocInfo + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L88) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +KVDocumentStore.persist + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L52) + +--- + +### refDocExists + +▸ **refDocExists**(`refDocId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +KVDocumentStore.refDocExists + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L101) + +--- + +### setDocumentHash + +▸ **setDocumentHash**(`docId`, `docHash`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `docId` | `string` | +| `docHash` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.setDocumentHash + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:169](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/KVDocumentStore.ts#L169) + +--- + +### toDict + +▸ **toDict**(): `SaveDict` + +#### Returns + +`SaveDict` + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L73) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`, `namespace?`): [`SimpleDocumentStore`](SimpleDocumentStore.md) + +#### Parameters + +| Name | Type | +| :----------- | :--------- | +| `saveDict` | `SaveDict` | +| `namespace?` | `string` | + +#### Returns + +[`SimpleDocumentStore`](SimpleDocumentStore.md) + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L68) + +--- + +### fromPersistDir + +▸ `Static` **fromPersistDir**(`persistDir?`, `namespace?`, `fsModule?`): `Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------------------------------------------------------- | :-------------------- | +| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` | +| `namespace?` | `string` | `undefined` | +| `fsModule?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` | + +#### Returns + +`Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L26) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `namespace?`, `fs?`): `Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `namespace?` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L42) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleIndexStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleIndexStore.md new file mode 100644 index 0000000000000000000000000000000000000000..7871c946fa45e8aa7754f9d4633b61ad7f7501c0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleIndexStore.md @@ -0,0 +1,234 @@ +--- +id: "SimpleIndexStore" +title: "Class: SimpleIndexStore" +sidebar_label: "SimpleIndexStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `KVIndexStore` + + ↳ **`SimpleIndexStore`** + +## Constructors + +### constructor + +• **new SimpleIndexStore**(`kvStore?`) + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `kvStore?` | [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) | + +#### Overrides + +KVIndexStore.constructor + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L15) + +## Properties + +### kvStore + +• `Private` **kvStore**: [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L13) + +## Methods + +### addIndexStruct + +▸ **addIndexStruct**(`indexStruct`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------ | +| `indexStruct` | [`IndexStruct`](IndexStruct.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVIndexStore.addIndexStruct + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/KVIndexStore.ts#L17) + +--- + +### deleteIndexStruct + +▸ **deleteIndexStruct**(`key`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `key` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVIndexStore.deleteIndexStruct + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/KVIndexStore.ts#L23) + +--- + +### getIndexStruct + +▸ **getIndexStruct**(`structId?`): `Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `structId?` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Inherited from + +KVIndexStore.getIndexStruct + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/KVIndexStore.ts#L27) + +--- + +### getIndexStructs + +▸ **getIndexStructs**(): `Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Returns + +`Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Inherited from + +KVIndexStore.getIndexStructs + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/KVIndexStore.ts#L43) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :-------------------- | +| `persistPath` | `string` | `DEFAULT_PERSIST_DIR` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +KVIndexStore.persist + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L40) + +--- + +### toDict + +▸ **toDict**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L52) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`): [`SimpleIndexStore`](SimpleIndexStore.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `saveDict` | `DataType` | + +#### Returns + +[`SimpleIndexStore`](SimpleIndexStore.md) + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L47) + +--- + +### fromPersistDir + +▸ `Static` **fromPersistDir**(`persistDir?`, `fs?`): `Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------------------------------------------------------- | :-------------------- | +| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L21) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `persistPath` | `string` | `undefined` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L32) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleKVStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleKVStore.md new file mode 100644 index 0000000000000000000000000000000000000000..a032acd21242698c3b37cc65d9d94bf78a033d0f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleKVStore.md @@ -0,0 +1,239 @@ +--- +id: "SimpleKVStore" +title: "Class: SimpleKVStore" +sidebar_label: "SimpleKVStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseKVStore`](BaseKVStore.md) + + ↳ **`SimpleKVStore`** + +## Constructors + +### constructor + +• **new SimpleKVStore**(`data?`) + +#### Parameters + +| Name | Type | +| :------ | :--------- | +| `data?` | `DataType` | + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[constructor](BaseKVStore.md#constructor) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L14) + +## Properties + +### data + +• `Private` **data**: `DataType` + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L10) + +--- + +### fs + +• `Private` **fs**: `undefined` \| [`GenericFileSystem`](../interfaces/GenericFileSystem.md) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L12) + +--- + +### persistPath + +• `Private` **persistPath**: `undefined` \| `string` + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L11) + +## Methods + +### delete + +▸ **delete**(`key`, `collection?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `key` | `string` | `undefined` | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`boolean`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[delete](BaseKVStore.md#delete) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L52) + +--- + +### get + +▸ **get**(`key`, `collection?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `key` | `string` | `undefined` | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`any`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[get](BaseKVStore.md#get) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L34) + +--- + +### getAll + +▸ **getAll**(`collection?`): `Promise`<`DataType`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`DataType`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[getAll](BaseKVStore.md#getall) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L48) + +--- + +### persist + +▸ **persist**(`persistPath`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L63) + +--- + +### put + +▸ **put**(`key`, `val`, `collection?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `key` | `string` | `undefined` | +| `val` | `any` | `undefined` | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[put](BaseKVStore.md#put) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L19) + +--- + +### toDict + +▸ **toDict**(): `DataType` + +#### Returns + +`DataType` + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L99) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`): [`SimpleKVStore`](SimpleKVStore.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `saveDict` | `DataType` | + +#### Returns + +[`SimpleKVStore`](SimpleKVStore.md) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L103) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleKVStore`](SimpleKVStore.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<[`SimpleKVStore`](SimpleKVStore.md)\> + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/kvStore/SimpleKVStore.ts#L73) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleMongoReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleMongoReader.md new file mode 100644 index 0000000000000000000000000000000000000000..de8e94940cc766f5d99cea48a8318e438fb5f700 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleMongoReader.md @@ -0,0 +1,99 @@ +--- +id: "SimpleMongoReader" +title: "Class: SimpleMongoReader" +sidebar_label: "SimpleMongoReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read in from MongoDB + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new SimpleMongoReader**(`client`) + +#### Parameters + +| Name | Type | +| :------- | :------------ | +| `client` | `MongoClient` | + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleMongoReader.ts#L11) + +## Properties + +### client + +• `Private` **client**: `MongoClient` + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleMongoReader.ts#L9) + +## Methods + +### flatten + +▸ `Private` **flatten**(`texts`): `string`[] + +Flattens an array of strings or string arrays into a single-dimensional array of strings. + +#### Parameters + +| Name | Type | Description | +| :------ | :------------------------- | :------------------------------------------------ | +| `texts` | (`string` \| `string`[])[] | The array of strings or string arrays to flatten. | + +#### Returns + +`string`[] + +The flattened array of strings. + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleMongoReader.ts#L20) + +--- + +### loadData + +▸ **loadData**(`dbName`, `collectionName`, `fieldNames?`, `separator?`, `filterQuery?`, `maxDocs?`, `metadataNames?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Loads data from MongoDB collection + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------- | :------------ | :--------------------------------------------------------------------------------------------- | +| `dbName` | `string` | `undefined` | The name of the database to load. | +| `collectionName` | `string` | `undefined` | The name of the collection to load. | +| `fieldNames` | `string`[] | `undefined` | An array of field names to retrieve from each document. Defaults to ["text"]. | +| `separator` | `string` | `""` | The separator to join multiple field values. Defaults to an empty string. | +| `filterQuery` | `Record`<`string`, `any`\> | `{}` | Specific query, as specified by MongoDB NodeJS documentation. | +| `maxDocs` | `number` | `0` | The maximum number of documents to retrieve. Defaults to 0 (retrieve all documents). | +| `metadataNames?` | `string`[] | `undefined` | An optional array of metadata field names. If specified extracts this information as metadata. | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +**`Throws`** + +If a field specified in fieldNames or metadataNames is not found in a MongoDB document. + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleMongoReader.ts#L39) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleNodeParser.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleNodeParser.md new file mode 100644 index 0000000000000000000000000000000000000000..b1c2e6d60c13d0c42485c73b28796002d2b8b484 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleNodeParser.md @@ -0,0 +1,120 @@ +--- +id: "SimpleNodeParser" +title: "Class: SimpleNodeParser" +sidebar_label: "SimpleNodeParser" +sidebar_position: 0 +custom_edit_url: null +--- + +SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter + +## Implements + +- [`NodeParser`](../interfaces/NodeParser.md) + +## Constructors + +### constructor + +• **new SimpleNodeParser**(`init?`) + +#### Parameters + +| Name | Type | +| :------------------------- | :---------------------------------------- | +| `init?` | `Object` | +| `init.chunkOverlap?` | `number` | +| `init.chunkSize?` | `number` | +| `init.includeMetadata?` | `boolean` | +| `init.includePrevNextRel?` | `boolean` | +| `init.textSplitter?` | [`SentenceSplitter`](SentenceSplitter.md) | + +#### Defined in + +[packages/core/src/NodeParser.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L106) + +## Properties + +### includeMetadata + +• **includeMetadata**: `boolean` + +Whether to include metadata in the nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L100) + +--- + +### includePrevNextRel + +• **includePrevNextRel**: `boolean` + +Whether to include previous and next relationships in the nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L104) + +--- + +### textSplitter + +• **textSplitter**: [`SentenceSplitter`](SentenceSplitter.md) + +The text splitter to use. + +#### Defined in + +[packages/core/src/NodeParser.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L96) + +## Methods + +### getNodesFromDocuments + +▸ **getNodesFromDocuments**(`documents`): ([`TextNode`](TextNode.md)<[`Metadata`](../#metadata)\> \| [`ImageDocument`](ImageDocument.md)<`any`\>)[] + +Generate Node objects from documents + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------- | +| `documents` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +([`TextNode`](TextNode.md)<[`Metadata`](../#metadata)\> \| [`ImageDocument`](ImageDocument.md)<`any`\>)[] + +#### Implementation of + +[NodeParser](../interfaces/NodeParser.md).[getNodesFromDocuments](../interfaces/NodeParser.md#getnodesfromdocuments) + +#### Defined in + +[packages/core/src/NodeParser.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L137) + +--- + +### fromDefaults + +▸ `Static` **fromDefaults**(`init?`): [`SimpleNodeParser`](SimpleNodeParser.md) + +#### Parameters + +| Name | Type | +| :------------------------- | :-------- | +| `init?` | `Object` | +| `init.chunkOverlap?` | `number` | +| `init.chunkSize?` | `number` | +| `init.includeMetadata?` | `boolean` | +| `init.includePrevNextRel?` | `boolean` | + +#### Returns + +[`SimpleNodeParser`](SimpleNodeParser.md) + +#### Defined in + +[packages/core/src/NodeParser.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L124) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleResponseBuilder.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleResponseBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..c5da7835c904d9ee4d4be84efc4446350449bc51 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleResponseBuilder.md @@ -0,0 +1,75 @@ +--- +id: "SimpleResponseBuilder" +title: "Class: SimpleResponseBuilder" +sidebar_label: "SimpleResponseBuilder" +sidebar_position: 0 +custom_edit_url: null +--- + +A response builder that just concatenates responses. + +## Implements + +- `BaseResponseBuilder` + +## Constructors + +### constructor + +• **new SimpleResponseBuilder**(`serviceContext`) + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L53) + +## Properties + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L50) + +--- + +### textQATemplate + +• **textQATemplate**: [`SimplePrompt`](../#simpleprompt) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L51) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +BaseResponseBuilder.getResponse + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L58) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleVectorStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleVectorStore.md new file mode 100644 index 0000000000000000000000000000000000000000..48977add3c597503edc5d5daaf6ea1230bce2c00 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SimpleVectorStore.md @@ -0,0 +1,279 @@ +--- +id: "SimpleVectorStore" +title: "Class: SimpleVectorStore" +sidebar_label: "SimpleVectorStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`VectorStore`](../interfaces/VectorStore.md) + +## Constructors + +### constructor + +• **new SimpleVectorStore**(`data?`, `fs?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------- | +| `data?` | `SimpleVectorStoreData` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L37) + +## Properties + +### data + +• `Private` **data**: `SimpleVectorStoreData` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L33) + +--- + +### fs + +• `Private` **fs**: [`GenericFileSystem`](../interfaces/GenericFileSystem.md) = `DEFAULT_FS` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L34) + +--- + +### persistPath + +• `Private` **persistPath**: `undefined` \| `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L35) + +--- + +### storesText + +• **storesText**: `boolean` = `false` + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[storesText](../interfaces/VectorStore.md#storestext) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L32) + +## Accessors + +### client + +• `get` **client**(): `any` + +#### Returns + +`any` + +#### Implementation of + +VectorStore.client + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L50) + +## Methods + +### add + +▸ **add**(`embeddingResults`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------- | +| `embeddingResults` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`string`[]\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[add](../interfaces/VectorStore.md#add) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L58) + +--- + +### delete + +▸ **delete**(`refDocId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[delete](../interfaces/VectorStore.md#delete) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L77) + +--- + +### get + +▸ **get**(`textId`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `textId` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L54) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L146) + +--- + +### query + +▸ **query**(`query`): `Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------ | +| `query` | [`VectorStoreQuery`](../interfaces/VectorStoreQuery.md) | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[query](../interfaces/VectorStore.md#query) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L88) + +--- + +### toDict + +▸ **toDict**(): `SimpleVectorStoreData` + +#### Returns + +`SimpleVectorStoreData` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:196](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L196) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`): [`SimpleVectorStore`](SimpleVectorStore.md) + +#### Parameters + +| Name | Type | +| :--------- | :---------------------- | +| `saveDict` | `SimpleVectorStoreData` | + +#### Returns + +[`SimpleVectorStore`](SimpleVectorStore.md) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:189](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L189) + +--- + +### fromPersistDir + +▸ `Static` **fromPersistDir**(`persistDir?`, `fs?`): `Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------------------------------------------------------- | :-------------------- | +| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L42) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L159) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SubQuestionOutputParser.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SubQuestionOutputParser.md new file mode 100644 index 0000000000000000000000000000000000000000..fa7921508a8800dc9acaacc0f06320e437afe47f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SubQuestionOutputParser.md @@ -0,0 +1,67 @@ +--- +id: "SubQuestionOutputParser" +title: "Class: SubQuestionOutputParser" +sidebar_label: "SubQuestionOutputParser" +sidebar_position: 0 +custom_edit_url: null +--- + +SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator. + +## Implements + +- [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\> + +## Constructors + +### constructor + +• **new SubQuestionOutputParser**() + +## Methods + +### format + +▸ **format**(`output`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +`string` + +#### Implementation of + +[BaseOutputParser](../interfaces/BaseOutputParser.md).[format](../interfaces/BaseOutputParser.md#format) + +#### Defined in + +[packages/core/src/OutputParser.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L98) + +--- + +### parse + +▸ **parse**(`output`): [`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Implementation of + +[BaseOutputParser](../interfaces/BaseOutputParser.md).[parse](../interfaces/BaseOutputParser.md#parse) + +#### Defined in + +[packages/core/src/OutputParser.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L90) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SubQuestionQueryEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SubQuestionQueryEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..7a7b2e9beacf5d45515c40eda086d4206b08e90b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SubQuestionQueryEngine.md @@ -0,0 +1,143 @@ +--- +id: "SubQuestionQueryEngine" +title: "Class: SubQuestionQueryEngine" +sidebar_label: "SubQuestionQueryEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +SubQuestionQueryEngine decomposes a question into subquestions and then + +## Implements + +- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +## Constructors + +### constructor + +• **new SubQuestionQueryEngine**(`init`) + +#### Parameters + +| Name | Type | +| :------------------------- | :---------------------------------------------------------------- | +| `init` | `Object` | +| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] | +| `init.questionGen` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) | +| `init.responseSynthesizer` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | + +#### Defined in + +[packages/core/src/QueryEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L89) + +## Properties + +### metadatas + +• **metadatas**: [`ToolMetadata`](../interfaces/ToolMetadata.md)[] + +#### Defined in + +[packages/core/src/QueryEngine.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L87) + +--- + +### queryEngines + +• **queryEngines**: `Record`<`string`, [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L86) + +--- + +### questionGen + +• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L85) + +--- + +### responseSynthesizer + +• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L84) + +## Methods + +### query + +▸ **query**(`query`): `Promise`<[`Response`](Response.md)\> + +Query the query engine and get a response. + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`Response`](Response.md)\> + +#### Implementation of + +[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query) + +#### Defined in + +[packages/core/src/QueryEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L130) + +--- + +### querySubQ + +▸ `Private` **querySubQ**(`subQ`, `parentEvent?`): `Promise`<`null` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------------------- | +| `subQ` | [`SubQuestion`](../interfaces/SubQuestion.md) | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`null` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L158) + +--- + +### fromDefaults + +▸ `Static` **fromDefaults**(`init`): [`SubQuestionQueryEngine`](SubQuestionQueryEngine.md) + +#### Parameters + +| Name | Type | +| :-------------------------- | :---------------------------------------------------------------- | +| `init` | `Object` | +| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] | +| `init.questionGen?` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) | +| `init.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | +| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +[`SubQuestionQueryEngine`](SubQuestionQueryEngine.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L106) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryChatHistory.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryChatHistory.md new file mode 100644 index 0000000000000000000000000000000000000000..5f8ab6adb23d4f7cee81815c8f4265ce084a80ef --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryChatHistory.md @@ -0,0 +1,289 @@ +--- +id: "SummaryChatHistory" +title: "Class: SummaryChatHistory" +sidebar_label: "SummaryChatHistory" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatHistory is used to keep the state of back and forth chat messages + +## Implements + +- [`ChatHistory`](../interfaces/ChatHistory.md) + +## Constructors + +### constructor + +• **new SummaryChatHistory**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------- | +| `init?` | `Partial`<[`SummaryChatHistory`](SummaryChatHistory.md)\> | + +#### Defined in + +[packages/core/src/ChatHistory.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L70) + +## Properties + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatHistory.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L67) + +--- + +### messages + +• **messages**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[messages](../interfaces/ChatHistory.md#messages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L65) + +--- + +### messagesBefore + +• `Private` **messagesBefore**: `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L68) + +--- + +### summaryPrompt + +• **summaryPrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ChatHistory.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L66) + +--- + +### tokensToSummarize + +• **tokensToSummarize**: `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L64) + +## Accessors + +### nonSystemMessages + +• `Private` `get` **nonSystemMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L127) + +--- + +### systemMessages + +• `Private` `get` **systemMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L122) + +## Methods + +### addMessage + +▸ **addMessage**(`message`): `void` + +Adds a message to the chat history. + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------- | +| `message` | [`ChatMessage`](../interfaces/ChatMessage.md) | + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[addMessage](../interfaces/ChatHistory.md#addmessage) + +#### Defined in + +[packages/core/src/ChatHistory.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L106) + +--- + +### calcConversationMessages + +▸ `Private` **calcConversationMessages**(`transformSummary?`): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +Calculates the messages that describe the conversation so far. +If there's no memory, all non-system messages are used. +If there's a memory, uses all messages after the last summary message. + +#### Parameters + +| Name | Type | +| :------------------ | :-------- | +| `transformSummary?` | `boolean` | + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L137) + +--- + +### calcCurrentRequestMessages + +▸ `Private` **calcCurrentRequestMessages**(`transientMessages?`): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `transientMessages?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L155) + +--- + +### getLastSummaryIndex + +▸ `Private` **getLastSummaryIndex**(): `null` \| `number` + +#### Returns + +`null` \| `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L111) + +--- + +### newMessages + +▸ **newMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +Returns the new messages since the last call to this function (or since calling the constructor) + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[newMessages](../interfaces/ChatHistory.md#newmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:195](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L195) + +--- + +### requestMessages + +▸ **requestMessages**(`transientMessages?`): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +Returns the messages that should be used as input to the LLM. + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `transientMessages?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[requestMessages](../interfaces/ChatHistory.md#requestmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L165) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[reset](../interfaces/ChatHistory.md#reset) + +#### Defined in + +[packages/core/src/ChatHistory.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L191) + +--- + +### summarize + +▸ `Private` **summarize**(): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)\> + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)\> + +#### Defined in + +[packages/core/src/ChatHistory.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L84) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndex.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..97e8cef0659fc83e7e093246e8943265b547a824 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndex.md @@ -0,0 +1,352 @@ +--- +id: "SummaryIndex" +title: "Class: SummaryIndex" +sidebar_label: "SummaryIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +A SummaryIndex keeps nodes in a sequential order for use with summarization. + +## Hierarchy + +- [`BaseIndex`](BaseIndex.md)<[`IndexList`](IndexList.md)\> + + ↳ **`SummaryIndex`** + +## Constructors + +### constructor + +• **new SummaryIndex**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------ | +| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<[`IndexList`](IndexList.md)\> | + +#### Overrides + +[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L48) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L158) + +--- + +### indexStruct + +• **indexStruct**: [`IndexList`](IndexList.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L157) + +## Methods + +### asQueryEngine + +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | - | +| `options.preFilters?` | `unknown` | - | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L156) + +--- + +### asRetriever + +▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :------------- | :--------------------------------------------------------- | +| `options?` | `Object` | +| `options.mode` | [`SummaryRetrieverMode`](../enums/SummaryRetrieverMode.md) | + +#### Returns + +[`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L143) + +--- + +### deleteNodes + +▸ **deleteNodes**(`nodeIds`, `deleteFromDocStore`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------- | :--------- | +| `nodeIds` | `string`[] | +| `deleteFromDocStore` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L224) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------- | +| `refDocId` | `string` | +| `deleteFromDocStore?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L205) + +--- + +### getRefDocInfo + +▸ **getRefDocInfo**(): `Promise`<`Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Returns + +`Promise`<`Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L238) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L199) + +--- + +### buildIndexFromNodes + +▸ `Static` **buildIndexFromNodes**(`nodes`, `docStore`, `indexStruct?`): `Promise`<[`IndexList`](IndexList.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | +| `docStore` | [`BaseDocumentStore`](BaseDocumentStore.md) | +| `indexStruct?` | [`IndexList`](IndexList.md) | + +#### Returns + +`Promise`<[`IndexList`](IndexList.md)\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:184](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L184) + +--- + +### fromDocuments + +▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Parameters + +| Name | Type | +| :--------------------- | :------------------------------------------------------- | +| `documents` | [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] | +| `args` | `Object` | +| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | + +#### Returns + +`Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L117) + +--- + +### init + +▸ `Static` **init**(`options`): `Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :-------------------- | +| `options` | `SummaryIndexOptions` | + +#### Returns + +`Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L52) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexLLMRetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexLLMRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..7f972c6ea8d74a33e074ee6ecc480915a73907c4 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexLLMRetriever.md @@ -0,0 +1,151 @@ +--- +id: "SummaryIndexLLMRetriever" +title: "Class: SummaryIndexLLMRetriever" +sidebar_label: "SummaryIndexLLMRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +LLM retriever for SummaryIndex which lets you select the most relevant chunks. + +## Implements + +- [`BaseRetriever`](../interfaces/BaseRetriever.md) + +## Constructors + +### constructor + +• **new SummaryIndexLLMRetriever**(`index`, `choiceSelectPrompt?`, `choiceBatchSize?`, `formatNodeBatchFn?`, `parseChoiceSelectAnswerFn?`, `serviceContext?`) + +#### Parameters + +| Name | Type | Default value | +| :--------------------------- | :-------------------------------------------------- | :------------ | +| `index` | [`SummaryIndex`](SummaryIndex.md) | `undefined` | +| `choiceSelectPrompt?` | (`__namedParameters`: `Object`) => `string` | `undefined` | +| `choiceBatchSize` | `number` | `10` | +| `formatNodeBatchFn?` | `NodeFormatterFunction` | `undefined` | +| `parseChoiceSelectAnswerFn?` | `ChoiceSelectParserFunction` | `undefined` | +| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` | + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L64) + +## Properties + +### choiceBatchSize + +• **choiceBatchSize**: `number` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L59) + +--- + +### choiceSelectPrompt + +• **choiceSelectPrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L58) + +--- + +### formatNodeBatchFn + +• **formatNodeBatchFn**: `NodeFormatterFunction` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L60) + +--- + +### index + +• **index**: [`SummaryIndex`](SummaryIndex.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L57) + +--- + +### parseChoiceSelectAnswerFn + +• **parseChoiceSelectAnswerFn**: `ChoiceSelectParserFunction` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L61) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L62) + +## Methods + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L127) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L81) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexRetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..0cdfb8e8d86059acec281fb5ab20718141f07a52 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexRetriever.md @@ -0,0 +1,82 @@ +--- +id: "SummaryIndexRetriever" +title: "Class: SummaryIndexRetriever" +sidebar_label: "SummaryIndexRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +Simple retriever for SummaryIndex that returns all nodes + +## Implements + +- [`BaseRetriever`](../interfaces/BaseRetriever.md) + +## Constructors + +### constructor + +• **new SummaryIndexRetriever**(`index`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------- | +| `index` | [`SummaryIndex`](SummaryIndex.md) | + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L22) + +## Properties + +### index + +• **index**: [`SummaryIndex`](SummaryIndex.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L20) + +## Methods + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L48) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L26) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TextFileReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TextFileReader.md new file mode 100644 index 0000000000000000000000000000000000000000..61696371981d18119e76569ea4136871b2a95e1b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TextFileReader.md @@ -0,0 +1,44 @@ +--- +id: "TextFileReader" +title: "Class: TextFileReader" +sidebar_label: "TextFileReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read a .txt file + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new TextFileReader**() + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------- | +| `file` | `string` | +| `fs` | [`CompleteFileSystem`](../#completefilesystem) | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L29) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TextNode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TextNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7997b6fc9ca453219b55eda3d5719edf6e0fc8bd --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TextNode.md @@ -0,0 +1,486 @@ +--- +id: "TextNode" +title: "Class: TextNode<T>" +sidebar_label: "TextNode" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`BaseNode`](BaseNode.md)<`T`\> + + ↳ **`TextNode`** + + ↳↳ [`IndexNode`](IndexNode.md) + + ↳↳ [`Document`](Document.md) + + ↳↳ [`ImageNode`](ImageNode.md) + +## Constructors + +### constructor + +• **new TextNode**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------ | +| `init?` | `Partial`<[`TextNode`](TextNode.md)<`T`\>\> | + +#### Overrides + +[BaseNode](BaseNode.md).[constructor](BaseNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L162) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[BaseNode](BaseNode.md).[embedding](BaseNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[BaseNode](BaseNode.md).[excludedEmbedMetadataKeys](BaseNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[BaseNode](BaseNode.md).[excludedLlmMetadataKeys](BaseNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[BaseNode](BaseNode.md).[hash](BaseNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[BaseNode](BaseNode.md).[id\_](BaseNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L50) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[BaseNode](BaseNode.md).[metadata](BaseNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[BaseNode](BaseNode.md).[relationships](BaseNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +BaseNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[BaseNode](BaseNode.md).[asRelatedNodeInfo](BaseNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Overrides + +[BaseNode](BaseNode.md).[generateHash](BaseNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Overrides + +[BaseNode](BaseNode.md).[getContent](BaseNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[BaseNode](BaseNode.md).[getEmbedding](BaseNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Overrides + +[BaseNode](BaseNode.md).[getMetadataStr](BaseNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[BaseNode](BaseNode.md).[getType](BaseNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L188) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Overrides + +[BaseNode](BaseNode.md).[setContent](BaseNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[BaseNode](BaseNode.md).[toJSON](BaseNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TreeSummarize.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TreeSummarize.md new file mode 100644 index 0000000000000000000000000000000000000000..9c3b6d1c961e2ed876f0f9a16b44008809d68bde --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/TreeSummarize.md @@ -0,0 +1,90 @@ +--- +id: "TreeSummarize" +title: "Class: TreeSummarize" +sidebar_label: "TreeSummarize" +sidebar_position: 0 +custom_edit_url: null +--- + +TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left. + +## Implements + +- `BaseResponseBuilder` + +## Constructors + +### constructor + +• **new TreeSummarize**(`serviceContext`, `summaryTemplate?`) + +#### Parameters + +| Name | Type | +| :----------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `summaryTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L217) + +## Properties + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L214) + +--- + +### summaryTemplate + +• **summaryTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L215) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +BaseResponseBuilder.getResponse + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L225) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/VectorIndexRetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/VectorIndexRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..b544ba05d825e2199a8000e210fae2227f33a907 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/VectorIndexRetriever.md @@ -0,0 +1,210 @@ +--- +id: "VectorIndexRetriever" +title: "Class: VectorIndexRetriever" +sidebar_label: "VectorIndexRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +VectorIndexRetriever retrieves nodes from a VectorIndex. + +## Implements + +- [`BaseRetriever`](../interfaces/BaseRetriever.md) + +## Constructors + +### constructor + +• **new VectorIndexRetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------- | +| `«destructured»` | `Object` | +| › `index` | [`VectorStoreIndex`](VectorStoreIndex.md) | +| › `similarityTopK?` | `number` | + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L24) + +## Properties + +### index + +• **index**: [`VectorStoreIndex`](VectorStoreIndex.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) + +--- + +### serviceContext + +• `Private` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) + +--- + +### similarityTopK + +• **similarityTopK**: `number` + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L21) + +## Methods + +### buildNodeListFromQueryResult + +▸ `Protected` **buildNodeListFromQueryResult**(`result`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------ | +| `result` | [`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md) | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L102) + +--- + +### buildVectorStoreQuery + +▸ `Protected` **buildVectorStoreQuery**(`embedModel`, `query`): `Promise`<[`VectorStoreQuery`](../interfaces/VectorStoreQuery.md)\> + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------------- | +| `embedModel` | [`BaseEmbedding`](BaseEmbedding.md) | +| `query` | `string` | + +#### Returns + +`Promise`<[`VectorStoreQuery`](../interfaces/VectorStoreQuery.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L89) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L120) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`, `preFilters?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L37) + +--- + +### sendEvent + +▸ `Protected` **sendEvent**(`query`, `nodesWithScores`, `parentEvent`): `void` + +#### Parameters + +| Name | Type | +| :---------------- | :------------------------------------------------------------------------------- | +| `query` | `string` | +| `nodesWithScores` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | +| `parentEvent` | `undefined` \| [`Event`](../interfaces/Event.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L72) + +--- + +### textRetrieve + +▸ `Protected` **textRetrieve**(`query`, `preFilters?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------- | +| `query` | `string` | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L50) + +--- + +### textToImageRetrieve + +▸ `Private` **textToImageRetrieve**(`query`, `preFilters?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------- | +| `query` | `string` | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/VectorStoreIndex.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/VectorStoreIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..5474249cc1939053efce0e089a0db7c2634f952d --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/VectorStoreIndex.md @@ -0,0 +1,503 @@ +--- +id: "VectorStoreIndex" +title: "Class: VectorStoreIndex" +sidebar_label: "VectorStoreIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +The VectorStoreIndex, an index that stores the nodes only according to their vector embedings. + +## Hierarchy + +- [`BaseIndex`](BaseIndex.md)<[`IndexDict`](IndexDict.md)\> + + ↳ **`VectorStoreIndex`** + +## Constructors + +### constructor + +• `Private` **new VectorStoreIndex**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :---------------------------- | +| `init` | `VectorIndexConstructorProps` | + +#### Overrides + +[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L64) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### embedModel + +• **embedModel**: [`BaseEmbedding`](BaseEmbedding.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L60) + +--- + +### imageEmbedModel + +• `Optional` **imageEmbedModel**: [`MultiModalEmbedding`](MultiModalEmbedding.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L62) + +--- + +### imageVectorStore + +• `Optional` **imageVectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L61) + +--- + +### indexStore + +• **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L59) + +--- + +### indexStruct + +• **indexStruct**: [`IndexDict`](IndexDict.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L58) + +## Methods + +### asQueryEngine + +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | - | +| `options.preFilters?` | `unknown` | - | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:244](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L244) + +--- + +### asRetriever + +▸ **asRetriever**(`options?`): [`VectorIndexRetriever`](VectorIndexRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `options?` | `any` | + +#### Returns + +[`VectorIndexRetriever`](VectorIndexRetriever.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L240) + +--- + +### buildIndexFromNodes + +▸ **buildIndexFromNodes**(`nodes`): `Promise`<`void`\> + +Get embeddings for nodes and place them into the index. + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L178) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :-------- | :------------ | +| `refDocId` | `string` | `undefined` | +| `deleteFromDocStore` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:305](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L305) + +--- + +### deleteRefDocFromStore + +▸ `Protected` **deleteRefDocFromStore**(`vectorStore`, `refDocId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:319](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L319) + +--- + +### getImageNodeEmbeddingResults + +▸ **getImageNodeEmbeddingResults**(`nodes`, `logProgress?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +Get the embeddings for image nodes. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :--------------------------------------------------------- | :------------ | :--------------------------------------------- | +| `nodes` | [`ImageNode`](ImageNode.md)<[`Metadata`](../#metadata)\>[] | `undefined` | | +| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:345](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L345) + +--- + +### getNodeEmbeddingResults + +▸ **getNodeEmbeddingResults**(`nodes`, `logProgress?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +Get the embeddings for nodes. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :------------------------------------------------------- | :------------ | :--------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | `undefined` | | +| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L155) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:284](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L284) + +--- + +### insertNodesToStore + +▸ `Protected` **insertNodesToStore**(`vectorStore`, `nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------- | +| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:259](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L259) + +--- + +### splitNodes + +▸ `Private` **splitNodes**(`nodes`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Object` + +| Name | Type | +| :----------- | :--------------------------------------------------------- | +| `imageNodes` | [`ImageNode`](ImageNode.md)<[`Metadata`](../#metadata)\>[] | +| `textNodes` | [`TextNode`](TextNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:367](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L367) + +--- + +### fromDocuments + +▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +High level API: split documents, get embeddings, and build index. + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------- | +| `documents` | [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] | +| `args` | `VectorIndexOptions` | + +#### Returns + +`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:201](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L201) + +--- + +### fromVectorStore + +▸ `Static` **fromVectorStore**(`vectorStore`, `serviceContext`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------------------- | +| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L219) + +--- + +### init + +▸ `Static` **init**(`options`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +The async init function creates a new VectorStoreIndex. + +#### Parameters + +| Name | Type | +| :-------- | :------------------- | +| `options` | `VectorIndexOptions` | + +#### Returns + +`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L80) + +--- + +### setupIndexStructFromStorage + +▸ `Static` `Private` **setupIndexStructFromStorage**(`indexStore`, `options`): `Promise`<`undefined` \| [`IndexDict`](IndexDict.md)\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------ | +| `indexStore` | [`BaseIndexStore`](BaseIndexStore.md) | +| `options` | `IndexStructOptions` | + +#### Returns + +`Promise`<`undefined` \| [`IndexDict`](IndexDict.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L118) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/_category_.yml b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..55c7980a46440f2ff50537c3392125668d3bb43e --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/classes/_category_.yml @@ -0,0 +1,2 @@ +label: "Classes" +position: 3 \ No newline at end of file diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/ClipEmbeddingModelType.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/ClipEmbeddingModelType.md new file mode 100644 index 0000000000000000000000000000000000000000..81470d568ddb26fa62547feac085d8bbc0d077d7 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/ClipEmbeddingModelType.md @@ -0,0 +1,27 @@ +--- +id: "ClipEmbeddingModelType" +title: "Enumeration: ClipEmbeddingModelType" +sidebar_label: "ClipEmbeddingModelType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### XENOVA_CLIP_VIT_BASE_PATCH16 + +• **XENOVA_CLIP_VIT_BASE_PATCH16** = `"Xenova/clip-vit-base-patch16"` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L7) + +--- + +### XENOVA_CLIP_VIT_BASE_PATCH32 + +• **XENOVA_CLIP_VIT_BASE_PATCH32** = `"Xenova/clip-vit-base-patch32"` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/ClipEmbedding.ts#L6) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/DeuceChatStrategy.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/DeuceChatStrategy.md new file mode 100644 index 0000000000000000000000000000000000000000..09d4a18429f2097bc1dbc51a7efeea6f2edd7a89 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/DeuceChatStrategy.md @@ -0,0 +1,57 @@ +--- +id: "DeuceChatStrategy" +title: "Enumeration: DeuceChatStrategy" +sidebar_label: "DeuceChatStrategy" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### A16Z + +• **A16Z** = `"a16z"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:411](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L411) + +--- + +### META + +• **META** = `"meta"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:412](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L412) + +--- + +### METAWBOS + +• **METAWBOS** = `"metawbos"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:413](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L413) + +--- + +### REPLICATE4BIT + +• **REPLICATE4BIT** = `"replicate4bit"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:416](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L416) + +--- + +### REPLICATE4BITWNEWLINES + +• **REPLICATE4BITWNEWLINES** = `"replicate4bitwnewlines"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:418](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L418) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/IndexStructType.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/IndexStructType.md new file mode 100644 index 0000000000000000000000000000000000000000..77c2f6351f05c88d082518f874ca0f0ad61002d1 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/IndexStructType.md @@ -0,0 +1,37 @@ +--- +id: "IndexStructType" +title: "Enumeration: IndexStructType" +sidebar_label: "IndexStructType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### KEYWORD_TABLE + +• **KEYWORD_TABLE** = `"keyword_table"` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L42) + +--- + +### LIST + +• **LIST** = `"list"` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L41) + +--- + +### SIMPLE_DICT + +• **SIMPLE_DICT** = `"simple_dict"` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L40) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/KeywordTableRetrieverMode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/KeywordTableRetrieverMode.md new file mode 100644 index 0000000000000000000000000000000000000000..b6fe99fad441dc27c38cf3fe04d18ed3cc1bbaad --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/KeywordTableRetrieverMode.md @@ -0,0 +1,37 @@ +--- +id: "KeywordTableRetrieverMode" +title: "Enumeration: KeywordTableRetrieverMode" +sidebar_label: "KeywordTableRetrieverMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"DEFAULT"` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L34) + +--- + +### RAKE + +• **RAKE** = `"RAKE"` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L36) + +--- + +### SIMPLE + +• **SIMPLE** = `"SIMPLE"` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/keyword/KeywordTableIndex.ts#L35) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/MetadataMode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/MetadataMode.md new file mode 100644 index 0000000000000000000000000000000000000000..555edee2d7e4df7dac9921bf9ea63c76075a68b9 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/MetadataMode.md @@ -0,0 +1,47 @@ +--- +id: "MetadataMode" +title: "Enumeration: MetadataMode" +sidebar_label: "MetadataMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### ALL + +• **ALL** = `"ALL"` + +#### Defined in + +[packages/core/src/Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L21) + +--- + +### EMBED + +• **EMBED** = `"EMBED"` + +#### Defined in + +[packages/core/src/Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L22) + +--- + +### LLM + +• **LLM** = `"LLM"` + +#### Defined in + +[packages/core/src/Node.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L23) + +--- + +### NONE + +• **NONE** = `"NONE"` + +#### Defined in + +[packages/core/src/Node.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L24) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/NodeRelationship.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/NodeRelationship.md new file mode 100644 index 0000000000000000000000000000000000000000..ec2b03c16af8e275056c18b90881027c22a5e3c3 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/NodeRelationship.md @@ -0,0 +1,57 @@ +--- +id: "NodeRelationship" +title: "Enumeration: NodeRelationship" +sidebar_label: "NodeRelationship" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### CHILD + +• **CHILD** = `"CHILD"` + +#### Defined in + +[packages/core/src/Node.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L9) + +--- + +### NEXT + +• **NEXT** = `"NEXT"` + +#### Defined in + +[packages/core/src/Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L7) + +--- + +### PARENT + +• **PARENT** = `"PARENT"` + +#### Defined in + +[packages/core/src/Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L8) + +--- + +### PREVIOUS + +• **PREVIOUS** = `"PREVIOUS"` + +#### Defined in + +[packages/core/src/Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L6) + +--- + +### SOURCE + +• **SOURCE** = `"SOURCE"` + +#### Defined in + +[packages/core/src/Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L5) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/ObjectType.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/ObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..4c1d2f9e9b3e86d23f2eb2a80558c728104b20c6 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/ObjectType.md @@ -0,0 +1,57 @@ +--- +id: "ObjectType" +title: "Enumeration: ObjectType" +sidebar_label: "ObjectType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DOCUMENT + +• **DOCUMENT** = `"DOCUMENT"` + +#### Defined in + +[packages/core/src/Node.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L16) + +--- + +### IMAGE + +• **IMAGE** = `"IMAGE"` + +#### Defined in + +[packages/core/src/Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L14) + +--- + +### IMAGE_DOCUMENT + +• **IMAGE_DOCUMENT** = `"IMAGE_DOCUMENT"` + +#### Defined in + +[packages/core/src/Node.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L17) + +--- + +### INDEX + +• **INDEX** = `"INDEX"` + +#### Defined in + +[packages/core/src/Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L15) + +--- + +### TEXT + +• **TEXT** = `"TEXT"` + +#### Defined in + +[packages/core/src/Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L13) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/OpenAIEmbeddingModelType.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/OpenAIEmbeddingModelType.md new file mode 100644 index 0000000000000000000000000000000000000000..393b9dee3c66691cb6228d126945327920760fde --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/OpenAIEmbeddingModelType.md @@ -0,0 +1,17 @@ +--- +id: "OpenAIEmbeddingModelType" +title: "Enumeration: OpenAIEmbeddingModelType" +sidebar_label: "OpenAIEmbeddingModelType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### TEXT_EMBED_ADA_002 + +• **TEXT_EMBED_ADA_002** = `"text-embedding-ada-002"` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/OpenAIEmbedding.ts#L13) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/SimilarityType.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/SimilarityType.md new file mode 100644 index 0000000000000000000000000000000000000000..4692571ab0cc75b2128e35752e9e1cee74911417 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/SimilarityType.md @@ -0,0 +1,40 @@ +--- +id: "SimilarityType" +title: "Enumeration: SimilarityType" +sidebar_label: "SimilarityType" +sidebar_position: 0 +custom_edit_url: null +--- + +Similarity type +Default is cosine similarity. Dot product and negative Euclidean distance are also supported. + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"cosine"` + +#### Defined in + +[packages/core/src/embeddings/types.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L8) + +--- + +### DOT_PRODUCT + +• **DOT_PRODUCT** = `"dot_product"` + +#### Defined in + +[packages/core/src/embeddings/types.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L9) + +--- + +### EUCLIDEAN + +• **EUCLIDEAN** = `"euclidean"` + +#### Defined in + +[packages/core/src/embeddings/types.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/types.ts#L10) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/SummaryRetrieverMode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/SummaryRetrieverMode.md new file mode 100644 index 0000000000000000000000000000000000000000..e08ab6e6beab7fe52804e5e9511362fc27eab1ce --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/SummaryRetrieverMode.md @@ -0,0 +1,27 @@ +--- +id: "SummaryRetrieverMode" +title: "Enumeration: SummaryRetrieverMode" +sidebar_label: "SummaryRetrieverMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"default"` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L31) + +--- + +### LLM + +• **LLM** = `"llm"` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L33) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/Tokenizers.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/Tokenizers.md new file mode 100644 index 0000000000000000000000000000000000000000..6d76282b71fcb20835eda41933ef1519cbb15a21 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/Tokenizers.md @@ -0,0 +1,17 @@ +--- +id: "Tokenizers" +title: "Enumeration: Tokenizers" +sidebar_label: "Tokenizers" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### CL100K_BASE + +• **CL100K_BASE** = `"cl100k_base"` + +#### Defined in + +[packages/core/src/GlobalsHelper.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/GlobalsHelper.ts#L7) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/VectorStoreQueryMode.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/VectorStoreQueryMode.md new file mode 100644 index 0000000000000000000000000000000000000000..20d579a0306c950d020f2bd306c9eea1578815e1 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/VectorStoreQueryMode.md @@ -0,0 +1,77 @@ +--- +id: "VectorStoreQueryMode" +title: "Enumeration: VectorStoreQueryMode" +sidebar_label: "VectorStoreQueryMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"default"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L10) + +--- + +### HYBRID + +• **HYBRID** = `"hybrid"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L12) + +--- + +### LINEAR_REGRESSION + +• **LINEAR_REGRESSION** = `"linear_regression"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L16) + +--- + +### LOGISTIC_REGRESSION + +• **LOGISTIC_REGRESSION** = `"logistic_regression"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L15) + +--- + +### MMR + +• **MMR** = `"mmr"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L18) + +--- + +### SPARSE + +• **SPARSE** = `"sparse"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L11) + +--- + +### SVM + +• **SVM** = `"svm"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/_category_.yml b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..1687a9e03fd705b092a975c2bd86f8e76af69ea1 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/enums/_category_.yml @@ -0,0 +1,2 @@ +label: "Enumerations" +position: 2 \ No newline at end of file diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/index.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/index.md new file mode 100644 index 0000000000000000000000000000000000000000..26d54c15ac82cc7e1e96eed3b7a86ef50842e47f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/index.md @@ -0,0 +1,1554 @@ +--- +id: "index" +title: "llamaindex" +sidebar_label: "Exports" +sidebar_position: 0.5 +custom_edit_url: null +--- + +## Enumerations + +- [ClipEmbeddingModelType](enums/ClipEmbeddingModelType.md) +- [DeuceChatStrategy](enums/DeuceChatStrategy.md) +- [IndexStructType](enums/IndexStructType.md) +- [KeywordTableRetrieverMode](enums/KeywordTableRetrieverMode.md) +- [MetadataMode](enums/MetadataMode.md) +- [NodeRelationship](enums/NodeRelationship.md) +- [ObjectType](enums/ObjectType.md) +- [OpenAIEmbeddingModelType](enums/OpenAIEmbeddingModelType.md) +- [SimilarityType](enums/SimilarityType.md) +- [SummaryRetrieverMode](enums/SummaryRetrieverMode.md) +- [Tokenizers](enums/Tokenizers.md) +- [VectorStoreQueryMode](enums/VectorStoreQueryMode.md) + +## Classes + +- [Anthropic](classes/Anthropic.md) +- [BaseDocumentStore](classes/BaseDocumentStore.md) +- [BaseEmbedding](classes/BaseEmbedding.md) +- [BaseInMemoryKVStore](classes/BaseInMemoryKVStore.md) +- [BaseIndex](classes/BaseIndex.md) +- [BaseIndexStore](classes/BaseIndexStore.md) +- [BaseKVStore](classes/BaseKVStore.md) +- [BaseNode](classes/BaseNode.md) +- [CallbackManager](classes/CallbackManager.md) +- [ClipEmbedding](classes/ClipEmbedding.md) +- [CompactAndRefine](classes/CompactAndRefine.md) +- [CondenseQuestionChatEngine](classes/CondenseQuestionChatEngine.md) +- [ContextChatEngine](classes/ContextChatEngine.md) +- [DefaultContextGenerator](classes/DefaultContextGenerator.md) +- [Document](classes/Document.md) +- [HTMLReader](classes/HTMLReader.md) +- [HistoryChatEngine](classes/HistoryChatEngine.md) +- [ImageDocument](classes/ImageDocument.md) +- [ImageNode](classes/ImageNode.md) +- [InMemoryFileSystem](classes/InMemoryFileSystem.md) +- [IndexDict](classes/IndexDict.md) +- [IndexList](classes/IndexList.md) +- [IndexNode](classes/IndexNode.md) +- [IndexStruct](classes/IndexStruct.md) +- [KeywordTable](classes/KeywordTable.md) +- [KeywordTableIndex](classes/KeywordTableIndex.md) +- [KeywordTableLLMRetriever](classes/KeywordTableLLMRetriever.md) +- [KeywordTableRAKERetriever](classes/KeywordTableRAKERetriever.md) +- [KeywordTableSimpleRetriever](classes/KeywordTableSimpleRetriever.md) +- [LLMQuestionGenerator](classes/LLMQuestionGenerator.md) +- [LlamaDeuce](classes/LlamaDeuce.md) +- [MarkdownReader](classes/MarkdownReader.md) +- [MongoDBAtlasVectorSearch](classes/MongoDBAtlasVectorSearch.md) +- [MultiModalEmbedding](classes/MultiModalEmbedding.md) +- [NotionReader](classes/NotionReader.md) +- [OpenAI](classes/OpenAI.md) +- [OpenAIEmbedding](classes/OpenAIEmbedding.md) +- [PDFReader](classes/PDFReader.md) +- [PGVectorStore](classes/PGVectorStore.md) +- [PapaCSVReader](classes/PapaCSVReader.md) +- [Portkey](classes/Portkey.md) +- [PromptHelper](classes/PromptHelper.md) +- [Refine](classes/Refine.md) +- [Response](classes/Response.md) +- [ResponseSynthesizer](classes/ResponseSynthesizer.md) +- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md) +- [SentenceSplitter](classes/SentenceSplitter.md) +- [SimilarityPostprocessor](classes/SimilarityPostprocessor.md) +- [SimpleChatEngine](classes/SimpleChatEngine.md) +- [SimpleChatHistory](classes/SimpleChatHistory.md) +- [SimpleDirectoryReader](classes/SimpleDirectoryReader.md) +- [SimpleDocumentStore](classes/SimpleDocumentStore.md) +- [SimpleIndexStore](classes/SimpleIndexStore.md) +- [SimpleKVStore](classes/SimpleKVStore.md) +- [SimpleMongoReader](classes/SimpleMongoReader.md) +- [SimpleNodeParser](classes/SimpleNodeParser.md) +- [SimpleResponseBuilder](classes/SimpleResponseBuilder.md) +- [SimpleVectorStore](classes/SimpleVectorStore.md) +- [SubQuestionOutputParser](classes/SubQuestionOutputParser.md) +- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md) +- [SummaryChatHistory](classes/SummaryChatHistory.md) +- [SummaryIndex](classes/SummaryIndex.md) +- [SummaryIndexLLMRetriever](classes/SummaryIndexLLMRetriever.md) +- [SummaryIndexRetriever](classes/SummaryIndexRetriever.md) +- [TextFileReader](classes/TextFileReader.md) +- [TextNode](classes/TextNode.md) +- [TreeSummarize](classes/TreeSummarize.md) +- [VectorIndexRetriever](classes/VectorIndexRetriever.md) +- [VectorStoreIndex](classes/VectorStoreIndex.md) + +## Interfaces + +- [BaseIndexInit](interfaces/BaseIndexInit.md) +- [BaseNodePostprocessor](interfaces/BaseNodePostprocessor.md) +- [BaseOutputParser](interfaces/BaseOutputParser.md) +- [BaseQueryEngine](interfaces/BaseQueryEngine.md) +- [BaseQuestionGenerator](interfaces/BaseQuestionGenerator.md) +- [BaseReader](interfaces/BaseReader.md) +- [BaseRetriever](interfaces/BaseRetriever.md) +- [BaseTool](interfaces/BaseTool.md) +- [ChatEngine](interfaces/ChatEngine.md) +- [ChatHistory](interfaces/ChatHistory.md) +- [ChatMessage](interfaces/ChatMessage.md) +- [ChatResponse](interfaces/ChatResponse.md) +- [Context](interfaces/Context.md) +- [ContextGenerator](interfaces/ContextGenerator.md) +- [DefaultStreamToken](interfaces/DefaultStreamToken.md) +- [Event](interfaces/Event.md) +- [ExactMatchFilter](interfaces/ExactMatchFilter.md) +- [GenericFileSystem](interfaces/GenericFileSystem.md) +- [LLM](interfaces/LLM.md) +- [LLMMetadata](interfaces/LLMMetadata.md) +- [MessageContentDetail](interfaces/MessageContentDetail.md) +- [MetadataFilters](interfaces/MetadataFilters.md) +- [MetadataInfo](interfaces/MetadataInfo.md) +- [NodeParser](interfaces/NodeParser.md) +- [NodeWithScore](interfaces/NodeWithScore.md) +- [QueryEngineTool](interfaces/QueryEngineTool.md) +- [RefDocInfo](interfaces/RefDocInfo.md) +- [RelatedNodeInfo](interfaces/RelatedNodeInfo.md) +- [RetrievalCallbackResponse](interfaces/RetrievalCallbackResponse.md) +- [ServiceContext](interfaces/ServiceContext.md) +- [ServiceContextOptions](interfaces/ServiceContextOptions.md) +- [StorageContext](interfaces/StorageContext.md) +- [StreamCallbackResponse](interfaces/StreamCallbackResponse.md) +- [StructuredOutput](interfaces/StructuredOutput.md) +- [SubQuestion](interfaces/SubQuestion.md) +- [ToolMetadata](interfaces/ToolMetadata.md) +- [VectorStore](interfaces/VectorStore.md) +- [VectorStoreInfo](interfaces/VectorStoreInfo.md) +- [VectorStoreQuery](interfaces/VectorStoreQuery.md) +- [VectorStoreQueryResult](interfaces/VectorStoreQueryResult.md) +- [VectorStoreQuerySpec](interfaces/VectorStoreQuerySpec.md) +- [WalkableFileSystem](interfaces/WalkableFileSystem.md) + +## Type Aliases + +### AnthropicStreamToken + +Ƭ **AnthropicStreamToken**: `Object` + +#### Type declaration + +| Name | Type | +| :------------ | :---------------------- | +| `completion` | `string` | +| `log_id?` | `string` | +| `model` | `string` | +| `stop?` | `boolean` | +| `stop_reason` | `string` \| `undefined` | + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L42) + +--- + +### ChoiceSelectPrompt + +Ƭ **ChoiceSelectPrompt**: typeof [`defaultChoiceSelectPrompt`](#defaultchoiceselectprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L165) + +--- + +### CompleteFileSystem + +Ƭ **CompleteFileSystem**: [`GenericFileSystem`](interfaces/GenericFileSystem.md) & [`WalkableFileSystem`](interfaces/WalkableFileSystem.md) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L49) + +--- + +### CompletionResponse + +Ƭ **CompletionResponse**: [`ChatResponse`](interfaces/ChatResponse.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L51) + +--- + +### CondenseQuestionPrompt + +Ƭ **CondenseQuestionPrompt**: typeof [`defaultCondenseQuestionPrompt`](#defaultcondensequestionprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:346](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L346) + +--- + +### ContextSystemPrompt + +Ƭ **ContextSystemPrompt**: typeof [`defaultContextSystemPrompt`](#defaultcontextsystemprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:367](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L367) + +--- + +### EventTag + +Ƭ **EventTag**: `"intermediate"` \| `"final"` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L10) + +--- + +### EventType + +Ƭ **EventType**: `"retrieve"` \| `"llmPredict"` \| `"wrapper"` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L11) + +--- + +### ImageNodeConstructorProps + +Ƭ **ImageNodeConstructorProps**<`T`\>: `Pick`<[`ImageNode`](classes/ImageNode.md)<`T`\>, `"image"` \| `"id_"`\> & `Partial`<[`ImageNode`](classes/ImageNode.md)<`T`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------ | +| `T` | extends [`Metadata`](#metadata) | + +#### Defined in + +[packages/core/src/Node.ts:290](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L290) + +--- + +### ImageType + +Ƭ **ImageType**: `string` \| `Blob` \| `URL` + +#### Defined in + +[packages/core/src/Node.ts:288](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L288) + +--- + +### KeywordExtractPrompt + +Ƭ **KeywordExtractPrompt**: typeof [`defaultKeywordExtractPrompt`](#defaultkeywordextractprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:382](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L382) + +--- + +### ListIndex + +Ƭ **ListIndex**: [`SummaryIndex`](classes/SummaryIndex.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:264](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L264) + +--- + +### ListIndexLLMRetriever + +Ƭ **ListIndexLLMRetriever**: [`SummaryIndexLLMRetriever`](classes/SummaryIndexLLMRetriever.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L134) + +--- + +### ListIndexRetriever + +Ƭ **ListIndexRetriever**: [`SummaryIndexRetriever`](classes/SummaryIndexRetriever.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L133) + +--- + +### ListRetrieverMode + +Ƭ **ListRetrieverMode**: [`SummaryRetrieverMode`](enums/SummaryRetrieverMode.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:265](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/summary/SummaryIndex.ts#L265) + +--- + +### MessageContent + +Ƭ **MessageContent**: `string` \| [`MessageContentDetail`](interfaces/MessageContentDetail.md)[] + +Extended type for the content of a message that allows for multi-modal messages. + +#### Defined in + +[packages/core/src/ChatEngine.ts:350](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L350) + +--- + +### MessageType + +Ƭ **MessageType**: `"user"` \| `"assistant"` \| `"system"` \| `"generic"` \| `"function"` \| `"memory"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L31) + +--- + +### Metadata + +Ƭ **Metadata**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L27) + +--- + +### OpenAIStreamToken + +Ƭ **OpenAIStreamToken**: [`DefaultStreamToken`](interfaces/DefaultStreamToken.md) + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L41) + +--- + +### QueryKeywordExtractPrompt + +Ƭ **QueryKeywordExtractPrompt**: typeof [`defaultQueryKeywordExtractPrompt`](#defaultquerykeywordextractprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:398](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L398) + +--- + +### RefinePrompt + +Ƭ **RefinePrompt**: typeof [`defaultRefinePrompt`](#defaultrefineprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L106) + +--- + +### RelatedNodeType + +Ƭ **RelatedNodeType**<`T`\>: [`RelatedNodeInfo`](interfaces/RelatedNodeInfo.md)<`T`\> \| [`RelatedNodeInfo`](interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`Metadata`](#metadata) = [`Metadata`](#metadata) | + +#### Defined in + +[packages/core/src/Node.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L36) + +--- + +### SimpleDirectoryReaderLoadDataProps + +Ƭ **SimpleDirectoryReaderLoadDataProps**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------- | :------------------------------------------------------------ | +| `defaultReader?` | [`BaseReader`](interfaces/BaseReader.md) \| `null` | +| `directoryPath` | `string` | +| `fileExtToReader?` | `Record`<`string`, [`BaseReader`](interfaces/BaseReader.md)\> | +| `fs?` | [`CompleteFileSystem`](#completefilesystem) | + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L52) + +--- + +### SimplePrompt + +Ƭ **SimplePrompt**: (`input`: `Record`<`string`, `string` \| `undefined`\>) => `string` + +#### Type declaration + +▸ (`input`): `string` + +A SimplePrompt is a function that takes a dictionary of inputs and returns a string. +NOTE this is a different interface compared to LlamaIndex Python +NOTE 2: we default to empty string to make it easy to calculate prompt sizes + +##### Parameters + +| Name | Type | +| :------ | :------------------------------------------- | +| `input` | `Record`<`string`, `string` \| `undefined`\> | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L10) + +--- + +### SubQuestionPrompt + +Ƭ **SubQuestionPrompt**: typeof [`defaultSubQuestionPrompt`](#defaultsubquestionprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:314](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L314) + +--- + +### SummaryPrompt + +Ƭ **SummaryPrompt**: typeof [`defaultSummaryPrompt`](#defaultsummaryprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L73) + +--- + +### TextQaPrompt + +Ƭ **TextQaPrompt**: typeof [`defaultTextQaPrompt`](#defaulttextqaprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L37) + +--- + +### TreeSummarizePrompt + +Ƭ **TreeSummarizePrompt**: typeof [`defaultTreeSummarizePrompt`](#defaulttreesummarizeprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L131) + +## Variables + +### ALL_AVAILABLE_ANTHROPIC_MODELS + +• `Const` **ALL_AVAILABLE_ANTHROPIC_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------------------- | :------------------------------------- | +| `claude-2` | { `contextWindow`: `number` = 200000 } | +| `claude-2.contextWindow` | `number` | +| `claude-instant-1` | { `contextWindow`: `number` = 100000 } | +| `claude-instant-1.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:640](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L640) + +--- + +### ALL_AVAILABLE_LLAMADEUCE_MODELS + +• `Const` **ALL_AVAILABLE_LLAMADEUCE_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Llama-2-13b-chat-4bit` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "meta/llama-2-13b-chat:f4e2de70d66816a838a89eeeb621910adffb0dd0baba3976c96980970978018d" } | +| `Llama-2-13b-chat-4bit.contextWindow` | `number` | +| `Llama-2-13b-chat-4bit.replicateApi` | `string` | +| `Llama-2-13b-chat-old` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "a16z-infra/llama13b-v2-chat:df7690f1994d94e96ad9d568eac121aecf50684a0b0963b25a41cc40061269e5" } | +| `Llama-2-13b-chat-old.contextWindow` | `number` | +| `Llama-2-13b-chat-old.replicateApi` | `string` | +| `Llama-2-70b-chat-4bit` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "meta/llama-2-70b-chat:02e509c789964a7ea8736978a43525956ef40397be9033abf9fd2badfe68c9e3" } | +| `Llama-2-70b-chat-4bit.contextWindow` | `number` | +| `Llama-2-70b-chat-4bit.replicateApi` | `string` | +| `Llama-2-70b-chat-old` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "replicate/llama70b-v2-chat:e951f18578850b652510200860fc4ea62b3b16fac280f83ff32282f87bbd2e48" } | +| `Llama-2-70b-chat-old.contextWindow` | `number` | +| `Llama-2-70b-chat-old.replicateApi` | `string` | +| `Llama-2-7b-chat-4bit` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "meta/llama-2-7b-chat:13c3cdee13ee059ab779f0291d29054dab00a47dad8261375654de5540165fb0" } | +| `Llama-2-7b-chat-4bit.contextWindow` | `number` | +| `Llama-2-7b-chat-4bit.replicateApi` | `string` | +| `Llama-2-7b-chat-old` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "a16z-infra/llama7b-v2-chat:4f0a4744c7295c024a1de15e1a63c880d3da035fa1f49bfd344fe076074c8eea" } | +| `Llama-2-7b-chat-old.contextWindow` | `number` | +| `Llama-2-7b-chat-old.replicateApi` | `string` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:370](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L370) + +--- + +### ALL_AVAILABLE_OPENAI_MODELS + +• `Const` **ALL_AVAILABLE_OPENAI_MODELS**: `Object` + +We currently support GPT-3.5 and GPT-4 models + +#### Type declaration + +| Name | Type | +| :----------------------------------- | :------------------------------------- | +| `gpt-3.5-turbo` | { `contextWindow`: `number` = 4096 } | +| `gpt-3.5-turbo.contextWindow` | `number` | +| `gpt-3.5-turbo-1106` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-1106.contextWindow` | `number` | +| `gpt-3.5-turbo-16k` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-16k.contextWindow` | `number` | +| `gpt-4` | { `contextWindow`: `number` = 8192 } | +| `gpt-4.contextWindow` | `number` | +| `gpt-4-1106-preview` | { `contextWindow`: `number` = 128000 } | +| `gpt-4-1106-preview.contextWindow` | `number` | +| `gpt-4-32k` | { `contextWindow`: `number` = 32768 } | +| `gpt-4-32k.contextWindow` | `number` | +| `gpt-4-vision-preview` | { `contextWindow`: `number` = 8192 } | +| `gpt-4-vision-preview.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L119) + +--- + +### DEFAULT_CHUNK_OVERLAP + +• `Const` **DEFAULT_CHUNK_OVERLAP**: `20` + +#### Defined in + +[packages/core/src/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L5) + +--- + +### DEFAULT_CHUNK_OVERLAP_RATIO + +• `Const` **DEFAULT_CHUNK_OVERLAP_RATIO**: `0.1` + +#### Defined in + +[packages/core/src/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L6) + +--- + +### DEFAULT_CHUNK_SIZE + +• `Const` **DEFAULT_CHUNK_SIZE**: `1024` + +#### Defined in + +[packages/core/src/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L4) + +--- + +### DEFAULT_COLLECTION + +• `Const` **DEFAULT_COLLECTION**: `"data"` + +#### Defined in + +[packages/core/src/storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L1) + +--- + +### DEFAULT_CONTEXT_WINDOW + +• `Const` **DEFAULT_CONTEXT_WINDOW**: `3900` + +#### Defined in + +[packages/core/src/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L1) + +--- + +### DEFAULT_DOC_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_DOC_STORE_PERSIST_FILENAME**: `"doc_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L4) + +--- + +### DEFAULT_EMBEDDING_DIM + +• `Const` **DEFAULT_EMBEDDING_DIM**: `1536` + +#### Defined in + +[packages/core/src/constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L10) + +--- + +### DEFAULT_FS + +• `Const` **DEFAULT_FS**: [`GenericFileSystem`](interfaces/GenericFileSystem.md) \| [`CompleteFileSystem`](#completefilesystem) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L62) + +--- + +### DEFAULT_GRAPH_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_GRAPH_STORE_PERSIST_FILENAME**: `"graph_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L6) + +--- + +### DEFAULT_INDEX_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_INDEX_STORE_PERSIST_FILENAME**: `"index_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L3) + +--- + +### DEFAULT_NAMESPACE + +• `Const` **DEFAULT_NAMESPACE**: `"docstore"` + +#### Defined in + +[packages/core/src/storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L7) + +--- + +### DEFAULT_NUM_OUTPUTS + +• `Const` **DEFAULT_NUM_OUTPUTS**: `256` + +#### Defined in + +[packages/core/src/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L2) + +--- + +### DEFAULT_PADDING + +• `Const` **DEFAULT_PADDING**: `5` + +#### Defined in + +[packages/core/src/constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L11) + +--- + +### DEFAULT_PERSIST_DIR + +• `Const` **DEFAULT_PERSIST_DIR**: `"./storage"` + +#### Defined in + +[packages/core/src/storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L2) + +--- + +### DEFAULT_SIMILARITY_TOP_K + +• `Const` **DEFAULT_SIMILARITY_TOP_K**: `2` + +#### Defined in + +[packages/core/src/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/constants.ts#L7) + +--- + +### DEFAULT_VECTOR_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_VECTOR_STORE_PERSIST_FILENAME**: `"vector_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/constants.ts#L5) + +--- + +### FILE_EXT_TO_READER + +• `Const` **FILE_EXT_TO_READER**: `Record`<`string`, [`BaseReader`](interfaces/BaseReader.md)\> + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/SimpleDirectoryReader.ts#L38) + +--- + +### GPT35_MODELS + +• `Const` **GPT35_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :--------------------------------- | :------------------------------------ | +| `gpt-3.5-turbo` | { `contextWindow`: `number` = 4096 } | +| `gpt-3.5-turbo.contextWindow` | `number` | +| `gpt-3.5-turbo-1106` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-1106.contextWindow` | `number` | +| `gpt-3.5-turbo-16k` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-16k.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L110) + +--- + +### GPT4_MODELS + +• `Const` **GPT4_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------------------- | :------------------------------------- | +| `gpt-4` | { `contextWindow`: `number` = 8192 } | +| `gpt-4.contextWindow` | `number` | +| `gpt-4-1106-preview` | { `contextWindow`: `number` = 128000 } | +| `gpt-4-1106-preview.contextWindow` | `number` | +| `gpt-4-32k` | { `contextWindow`: `number` = 32768 } | +| `gpt-4-32k.contextWindow` | `number` | +| `gpt-4-vision-preview` | { `contextWindow`: `number` = 8192 } | +| `gpt-4-vision-preview.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L103) + +--- + +### globalsHelper + +• `Const` **globalsHelper**: `GlobalsHelper` + +#### Defined in + +[packages/core/src/GlobalsHelper.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/GlobalsHelper.ts#L76) + +--- + +### unixLineSeparator + +• `Const` **unixLineSeparator**: `"\n"` + +#### Defined in + +[packages/core/src/TextSplitter.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L44) + +--- + +### unixParagraphSeparator + +• `Const` **unixParagraphSeparator**: `string` + +#### Defined in + +[packages/core/src/TextSplitter.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L46) + +--- + +### windowsLineSeparator + +• `Const` **windowsLineSeparator**: `"\r\n"` + +#### Defined in + +[packages/core/src/TextSplitter.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L45) + +--- + +### windowsParagraphSeparator + +• `Const` **windowsParagraphSeparator**: `string` + +#### Defined in + +[packages/core/src/TextSplitter.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L47) + +## Functions + +### anthropicTextQaPrompt + +▸ **anthropicTextQaPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L39) + +--- + +### buildToolsText + +▸ **buildToolsText**(`tools`): `string` + +#### Parameters + +| Name | Type | +| :------ | :--------------------------------------------- | +| `tools` | [`ToolMetadata`](interfaces/ToolMetadata.md)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:243](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L243) + +--- + +### cjkSentenceTokenizer + +▸ **cjkSentenceTokenizer**(`text`): `null` \| `RegExpMatchArray` + +Tokenizes sentences. Suitable for Chinese, Japanese, and Korean. + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`null` \| `RegExpMatchArray` + +#### Defined in + +[packages/core/src/TextSplitter.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L36) + +--- + +### defaultChoiceSelectPrompt + +▸ **defaultChoiceSelectPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L133) + +--- + +### defaultCondenseQuestionPrompt + +▸ **defaultCondenseQuestionPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:330](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L330) + +--- + +### defaultContextSystemPrompt + +▸ **defaultContextSystemPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:360](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L360) + +--- + +### defaultKeywordExtractPrompt + +▸ **defaultKeywordExtractPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:369](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L369) + +--- + +### defaultQueryKeywordExtractPrompt + +▸ **defaultQueryKeywordExtractPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:384](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L384) + +--- + +### defaultRefinePrompt + +▸ **defaultRefinePrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L91) + +--- + +### defaultSubQuestionPrompt + +▸ **defaultSubQuestionPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:284](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L284) + +--- + +### defaultSummaryPrompt + +▸ **defaultSummaryPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L62) + +--- + +### defaultTextQaPrompt + +▸ **defaultTextQaPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L27) + +--- + +### defaultTreeSummarizePrompt + +▸ **defaultTreeSummarizePrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L121) + +--- + +### englishSentenceTokenizer + +▸ **englishSentenceTokenizer**(`text`): `null` \| `RegExpMatchArray` + +Tokenizes sentences. Suitable for English and most European languages. + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`null` \| `RegExpMatchArray` + +#### Defined in + +[packages/core/src/TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/TextSplitter.ts#L26) + +--- + +### exists + +▸ **exists**(`fs`, `path`): `Promise`<`boolean`\> + +Checks if a file exists. +Analogous to the os.path.exists function from Python. + +#### Parameters + +| Name | Type | Description | +| :----- | :----------------------------------------------------- | :----------------------------- | +| `fs` | [`GenericFileSystem`](interfaces/GenericFileSystem.md) | The filesystem to use. | +| `path` | `string` | The path to the file to check. | + +#### Returns + +`Promise`<`boolean`\> + +A promise that resolves to true if the file exists, false otherwise. + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L74) + +--- + +### getBiggestPrompt + +▸ **getBiggestPrompt**(`prompts`): [`SimplePrompt`](#simpleprompt) + +Get biggest empty prompt size from a list of prompts. +Used to calculate the maximum size of inputs to the LLM. + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------- | +| `prompts` | [`SimplePrompt`](#simpleprompt)[] | + +#### Returns + +[`SimplePrompt`](#simpleprompt) + +#### Defined in + +[packages/core/src/PromptHelper.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L21) + +--- + +### getEmptyPromptTxt + +▸ **getEmptyPromptTxt**(`prompt`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------------------------------ | +| `prompt` | [`SimplePrompt`](#simpleprompt) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/PromptHelper.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/PromptHelper.ts#L11) + +--- + +### getNodeFS + +▸ **getNodeFS**(): [`CompleteFileSystem`](#completefilesystem) + +#### Returns + +[`CompleteFileSystem`](#completefilesystem) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L51) + +--- + +### getNodesFromDocument + +▸ **getNodesFromDocument**(`doc`, `textSplitter`, `includeMetadata?`, `includePrevNextRel?`): [`ImageDocument`](classes/ImageDocument.md)<`any`\>[] \| [`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\>[] + +Generates an array of nodes from a document. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :---------------------------------------------------------- | :------------ | :--------------------------------------------------------------- | +| `doc` | [`BaseNode`](classes/BaseNode.md)<[`Metadata`](#metadata)\> | `undefined` | - | +| `textSplitter` | [`SentenceSplitter`](classes/SentenceSplitter.md) | `undefined` | The text splitter to use. | +| `includeMetadata` | `boolean` | `true` | Whether to include metadata in the nodes. | +| `includePrevNextRel` | `boolean` | `true` | Whether to include previous and next relationships in the nodes. | + +#### Returns + +[`ImageDocument`](classes/ImageDocument.md)<`any`\>[] \| [`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\>[] + +An array of nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L35) + +--- + +### getResponseBuilder + +▸ **getResponseBuilder**(`serviceContext`, `responseMode?`): `BaseResponseBuilder` + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------------------------------- | +| `serviceContext` | [`ServiceContext`](interfaces/ServiceContext.md) | +| `responseMode?` | `ResponseMode` | + +#### Returns + +`BaseResponseBuilder` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:271](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ResponseSynthesizer.ts#L271) + +--- + +### getTextSplitsFromDocument + +▸ **getTextSplitsFromDocument**(`document`, `textSplitter`): `string`[] + +Splits the text of a document into smaller parts. + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------------------- | :------------------------ | +| `document` | [`Document`](classes/Document.md)<[`Metadata`](#metadata)\> | The document to split. | +| `textSplitter` | [`SentenceSplitter`](classes/SentenceSplitter.md) | The text splitter to use. | + +#### Returns + +`string`[] + +An array of text splits. + +#### Defined in + +[packages/core/src/NodeParser.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L17) + +--- + +### getTopKEmbeddings + +▸ **getTopKEmbeddings**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingIds?`, `similarityCutoff?`): [`number`[], `any`[]] + +Get the top K embeddings from a list of embeddings ordered by similarity to the query. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :----------------- | :------------------------- | :-------------------------------------------- | +| `queryEmbedding` | `number`[] | `undefined` | | +| `embeddings` | `number`[][] | `undefined` | list of embeddings to consider | +| `similarityTopK` | `number` | `DEFAULT_SIMILARITY_TOP_K` | max number of embeddings to return, default 2 | +| `embeddingIds` | `null` \| `any`[] | `null` | ids of embeddings in the embeddings list | +| `similarityCutoff` | `null` \| `number` | `null` | minimum similarity score | + +#### Returns + +[`number`[], `any`[]] + +#### Defined in + +[packages/core/src/embeddings/utils.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/utils.ts#L69) + +--- + +### getTopKEmbeddingsLearner + +▸ **getTopKEmbeddingsLearner**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingsIds?`, `queryMode?`): [`number`[], `any`[]] + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :------------------------------------------------------ | :------------------------- | +| `queryEmbedding` | `number`[] | `undefined` | +| `embeddings` | `number`[][] | `undefined` | +| `similarityTopK?` | `number` | `undefined` | +| `embeddingsIds?` | `any`[] | `undefined` | +| `queryMode` | [`VectorStoreQueryMode`](enums/VectorStoreQueryMode.md) | `VectorStoreQueryMode.SVM` | + +#### Returns + +[`number`[], `any`[]] + +#### Defined in + +[packages/core/src/embeddings/utils.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/utils.ts#L111) + +--- + +### getTopKMMREmbeddings + +▸ **getTopKMMREmbeddings**(`queryEmbedding`, `embeddings`, `similarityFn?`, `similarityTopK?`, `embeddingIds?`, `_similarityCutoff?`, `mmrThreshold?`): [`number`[], `any`[]] + +#### Parameters + +| Name | Type | Default value | +| :------------------ | :----------------------------------------- | :------------ | +| `queryEmbedding` | `number`[] | `undefined` | +| `embeddings` | `number`[][] | `undefined` | +| `similarityFn` | `null` \| (...`args`: `any`[]) => `number` | `null` | +| `similarityTopK` | `null` \| `number` | `null` | +| `embeddingIds` | `null` \| `any`[] | `null` | +| `_similarityCutoff` | `null` \| `number` | `null` | +| `mmrThreshold` | `null` \| `number` | `null` | + +#### Returns + +[`number`[], `any`[]] + +#### Defined in + +[packages/core/src/embeddings/utils.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/utils.ts#L123) + +--- + +### jsonToIndexStruct + +▸ **jsonToIndexStruct**(`json`): [`IndexStruct`](classes/IndexStruct.md) + +#### Parameters + +| Name | Type | +| :----- | :---- | +| `json` | `any` | + +#### Returns + +[`IndexStruct`](classes/IndexStruct.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L74) + +--- + +### jsonToNode + +▸ **jsonToNode**(`json`, `type?`): [`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\> + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------- | +| `json` | `any` | +| `type?` | [`ObjectType`](enums/ObjectType.md) | + +#### Returns + +[`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\> + +#### Defined in + +[packages/core/src/Node.ts:268](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L268) + +--- + +### messagesToHistoryStr + +▸ **messagesToHistoryStr**(`messages`): `string` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------- | +| `messages` | [`ChatMessage`](interfaces/ChatMessage.md)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:348](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Prompt.ts#L348) + +--- + +### parseJsonMarkdown + +▸ **parseJsonMarkdown**(`text`): `any` + +#### Parameters + +| Name | Type | Description | +| :----- | :------- | :------------------------- | +| `text` | `string` | A markdown block with JSON | + +#### Returns + +`any` + +parsed JSON object + +#### Defined in + +[packages/core/src/OutputParser.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L56) + +--- + +### readImage + +▸ **readImage**(`input`): `Promise`<`RawImage`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------ | +| `input` | [`ImageType`](#imagetype) | + +#### Returns + +`Promise`<`RawImage`\> + +#### Defined in + +[packages/core/src/embeddings/utils.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/utils.ts#L188) + +--- + +### serviceContextFromDefaults + +▸ **serviceContextFromDefaults**(`options?`): [`ServiceContext`](interfaces/ServiceContext.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------- | +| `options?` | [`ServiceContextOptions`](interfaces/ServiceContextOptions.md) | + +#### Returns + +[`ServiceContext`](interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L30) + +--- + +### serviceContextFromServiceContext + +▸ **serviceContextFromServiceContext**(`serviceContext`, `options`): `Object` + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](interfaces/ServiceContext.md) | +| `options` | [`ServiceContextOptions`](interfaces/ServiceContextOptions.md) | + +#### Returns + +`Object` + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `callbackManager` | [`CallbackManager`](classes/CallbackManager.md) | +| `embedModel` | [`BaseEmbedding`](classes/BaseEmbedding.md) | +| `llm` | [`LLM`](interfaces/LLM.md) | +| `nodeParser` | [`NodeParser`](interfaces/NodeParser.md) | +| `promptHelper` | [`PromptHelper`](classes/PromptHelper.md) | + +#### Defined in + +[packages/core/src/ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L48) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +The similarity between two embeddings. + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------------------------------------------ | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +similarity score with higher numbers meaning the two embeddings are more similar + +#### Defined in + +[packages/core/src/embeddings/utils.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/embeddings/utils.ts#L15) + +--- + +### storageContextFromDefaults + +▸ **storageContextFromDefaults**(`«destructured»`): `Promise`<[`StorageContext`](interfaces/StorageContext.md)\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------- | +| `«destructured»` | `BuilderParams` | + +#### Returns + +`Promise`<[`StorageContext`](interfaces/StorageContext.md)\> + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/StorageContext.ts#L24) + +--- + +### walk + +▸ **walk**(`fs`, `dirPath`): `AsyncIterable`<`string`\> + +Recursively traverses a directory and yields all the paths to the files in it. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------------- | :------------------------------------- | +| `fs` | [`WalkableFileSystem`](interfaces/WalkableFileSystem.md) | The filesystem to use. | +| `dirPath` | `string` | The path to the directory to traverse. | + +#### Returns + +`AsyncIterable`<`string`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L91) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseIndexInit.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseIndexInit.md new file mode 100644 index 0000000000000000000000000000000000000000..dc7987528057ae5fde189555fcd6d812f58f0a5f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseIndexInit.md @@ -0,0 +1,73 @@ +--- +id: "BaseIndexInit" +title: "Interface: BaseIndexInit<T>" +sidebar_label: "BaseIndexInit" +sidebar_position: 0 +custom_edit_url: null +--- + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](../classes/BaseDocumentStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L143) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](../classes/BaseIndexStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L145) + +--- + +### indexStruct + +• **indexStruct**: `T` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L146) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L141) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](StorageContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L142) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](VectorStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseIndex.ts#L144) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseNodePostprocessor.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseNodePostprocessor.md new file mode 100644 index 0000000000000000000000000000000000000000..21074eb77f26906d7984f703fba1401756bda235 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseNodePostprocessor.md @@ -0,0 +1,35 @@ +--- +id: "BaseNodePostprocessor" +title: "Interface: BaseNodePostprocessor" +sidebar_label: "BaseNodePostprocessor" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implemented by + +- [`SimilarityPostprocessor`](../classes/SimilarityPostprocessor.md) + +## Properties + +### postprocessNodes + +• **postprocessNodes**: (`nodes`: [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[]) => [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Type declaration + +▸ (`nodes`): [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +##### Parameters + +| Name | Type | +| :------ | :----------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +##### Returns + +[`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/indices/BaseNodePostprocessor.ts#L4) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseOutputParser.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseOutputParser.md new file mode 100644 index 0000000000000000000000000000000000000000..347f8aa42f057d38971af37cc42a8a4fc319a655 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseOutputParser.md @@ -0,0 +1,59 @@ +--- +id: "BaseOutputParser" +title: "Interface: BaseOutputParser<T>" +sidebar_label: "BaseOutputParser" +sidebar_position: 0 +custom_edit_url: null +--- + +An OutputParser is used to extract structured data from the raw output of the LLM. + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Implemented by + +- [`SubQuestionOutputParser`](../classes/SubQuestionOutputParser.md) + +## Methods + +### format + +▸ **format**(`output`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L8) + +--- + +### parse + +▸ **parse**(`output`): `T` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +`T` + +#### Defined in + +[packages/core/src/OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L7) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseQueryEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseQueryEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..796e971c34137b91563620837d22896f9a02f985 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseQueryEngine.md @@ -0,0 +1,37 @@ +--- +id: "BaseQueryEngine" +title: "Interface: BaseQueryEngine" +sidebar_label: "BaseQueryEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +A query engine is a question answerer that can use one or more steps. + +## Implemented by + +- [`RetrieverQueryEngine`](../classes/RetrieverQueryEngine.md) +- [`SubQuestionQueryEngine`](../classes/SubQuestionQueryEngine.md) + +## Methods + +### query + +▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\> + +Query the query engine and get a response. + +#### Parameters + +| Name | Type | +| :------------- | :------------------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](Event.md) | + +#### Returns + +`Promise`<[`Response`](../classes/Response.md)\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QueryEngine.ts#L25) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseQuestionGenerator.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseQuestionGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..539d6fb210d35fc0c3215447b6a62eb50ef7b15a --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseQuestionGenerator.md @@ -0,0 +1,34 @@ +--- +id: "BaseQuestionGenerator" +title: "Interface: BaseQuestionGenerator" +sidebar_label: "BaseQuestionGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +QuestionGenerators generate new questions for the LLM using tools and a user query. + +## Implemented by + +- [`LLMQuestionGenerator`](../classes/LLMQuestionGenerator.md) + +## Methods + +### generate + +▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](SubQuestion.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------- | +| `tools` | [`ToolMetadata`](ToolMetadata.md)[] | +| `query` | `string` | + +#### Returns + +`Promise`<[`SubQuestion`](SubQuestion.md)[]\> + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L23) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseReader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseReader.md new file mode 100644 index 0000000000000000000000000000000000000000..0151d5d2c93c72c9e3b42dec8a7d125bd08e9b42 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseReader.md @@ -0,0 +1,40 @@ +--- +id: "BaseReader" +title: "Interface: BaseReader" +sidebar_label: "BaseReader" +sidebar_position: 0 +custom_edit_url: null +--- + +A reader takes imports data into Document objects. + +## Implemented by + +- [`HTMLReader`](../classes/HTMLReader.md) +- [`MarkdownReader`](../classes/MarkdownReader.md) +- [`NotionReader`](../classes/NotionReader.md) +- [`PDFReader`](../classes/PDFReader.md) +- [`PapaCSVReader`](../classes/PapaCSVReader.md) +- [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md) +- [`SimpleMongoReader`](../classes/SimpleMongoReader.md) +- [`TextFileReader`](../classes/TextFileReader.md) + +## Methods + +### loadData + +▸ **loadData**(`...args`): `Promise`<[`Document`](../classes/Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<[`Document`](../classes/Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/readers/base.ts#L7) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseRetriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..efb6142ce2b44d690523deb9740f87ec79c98d1e --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseRetriever.md @@ -0,0 +1,51 @@ +--- +id: "BaseRetriever" +title: "Interface: BaseRetriever" +sidebar_label: "BaseRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +Retrievers retrieve the nodes that most closely match our query in similarity. + +## Implemented by + +- [`SummaryIndexLLMRetriever`](../classes/SummaryIndexLLMRetriever.md) +- [`SummaryIndexRetriever`](../classes/SummaryIndexRetriever.md) +- [`VectorIndexRetriever`](../classes/VectorIndexRetriever.md) + +## Methods + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md) + +#### Returns + +[`ServiceContext`](ServiceContext.md) + +#### Defined in + +[packages/core/src/Retriever.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Retriever.ts#L14) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`, `preFilters?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](Event.md) | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Retriever.ts#L9) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseTool.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseTool.md new file mode 100644 index 0000000000000000000000000000000000000000..d93b11e1cdb535028d98b3a79b531b158a496421 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/BaseTool.md @@ -0,0 +1,25 @@ +--- +id: "BaseTool" +title: "Interface: BaseTool" +sidebar_label: "BaseTool" +sidebar_position: 0 +custom_edit_url: null +--- + +Simple Tool interface. Likely to change. + +## Hierarchy + +- **`BaseTool`** + + ↳ [`QueryEngineTool`](QueryEngineTool.md) + +## Properties + +### metadata + +• **metadata**: [`ToolMetadata`](ToolMetadata.md) + +#### Defined in + +[packages/core/src/Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Tool.ts#L12) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatEngine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..640c9c252ecfbeee857f899eb76b6b79a27dcedd --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatEngine.md @@ -0,0 +1,62 @@ +--- +id: "ChatEngine" +title: "Interface: ChatEngine" +sidebar_label: "ChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatEngine is used to handle back and forth chats between the application and the LLM. + +## Implemented by + +- [`CondenseQuestionChatEngine`](../classes/CondenseQuestionChatEngine.md) +- [`ContextChatEngine`](../classes/ContextChatEngine.md) +- [`SimpleChatEngine`](../classes/SimpleChatEngine.md) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](../classes/Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L29) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/ChatEngine.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L41) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatHistory.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatHistory.md new file mode 100644 index 0000000000000000000000000000000000000000..96da7fb3161b442bf591e5aa434d99d3302f2c0b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatHistory.md @@ -0,0 +1,100 @@ +--- +id: "ChatHistory" +title: "Interface: ChatHistory" +sidebar_label: "ChatHistory" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatHistory is used to keep the state of back and forth chat messages + +## Implemented by + +- [`SimpleChatHistory`](../classes/SimpleChatHistory.md) +- [`SummaryChatHistory`](../classes/SummaryChatHistory.md) + +## Properties + +### messages + +• **messages**: [`ChatMessage`](ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L12) + +## Methods + +### addMessage + +▸ **addMessage**(`message`): `void` + +Adds a message to the chat history. + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------ | +| `message` | [`ChatMessage`](ChatMessage.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/ChatHistory.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L17) + +--- + +### newMessages + +▸ **newMessages**(): [`ChatMessage`](ChatMessage.md)[] + +Returns the new messages since the last call to this function (or since calling the constructor) + +#### Returns + +[`ChatMessage`](ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L32) + +--- + +### requestMessages + +▸ **requestMessages**(`transientMessages?`): `Promise`<[`ChatMessage`](ChatMessage.md)[]\> + +Returns the messages that should be used as input to the LLM. + +#### Parameters + +| Name | Type | +| :------------------- | :-------------------------------- | +| `transientMessages?` | [`ChatMessage`](ChatMessage.md)[] | + +#### Returns + +`Promise`<[`ChatMessage`](ChatMessage.md)[]\> + +#### Defined in + +[packages/core/src/ChatHistory.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L22) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/ChatHistory.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatHistory.ts#L27) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatMessage.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatMessage.md new file mode 100644 index 0000000000000000000000000000000000000000..498950a0c5ecb8b09c4160d68358adcace2470ae --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatMessage.md @@ -0,0 +1,27 @@ +--- +id: "ChatMessage" +title: "Interface: ChatMessage" +sidebar_label: "ChatMessage" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### content + +• **content**: `any` + +#### Defined in + +[packages/core/src/llm/LLM.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L40) + +--- + +### role + +• **role**: [`MessageType`](../#messagetype) + +#### Defined in + +[packages/core/src/llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L41) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatResponse.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..bda50818a8028000c97c6aa7089c8694d09f5348 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ChatResponse.md @@ -0,0 +1,37 @@ +--- +id: "ChatResponse" +title: "Interface: ChatResponse" +sidebar_label: "ChatResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### delta + +• `Optional` **delta**: `string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L47) + +--- + +### message + +• **message**: [`ChatMessage`](ChatMessage.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L45) + +--- + +### raw + +• `Optional` **raw**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L46) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/Context.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/Context.md new file mode 100644 index 0000000000000000000000000000000000000000..4cc383ccd9c1e7c740dc2f487e20f4e8ce954ed7 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/Context.md @@ -0,0 +1,27 @@ +--- +id: "Context" +title: "Interface: Context" +sidebar_label: "Context" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### message + +• **message**: [`ChatMessage`](ChatMessage.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L175) + +--- + +### nodes + +• **nodes**: [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L176) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ContextGenerator.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ContextGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..d5312bd2466ebcc18b4c7bffc014c7e687eec242 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ContextGenerator.md @@ -0,0 +1,32 @@ +--- +id: "ContextGenerator" +title: "Interface: ContextGenerator" +sidebar_label: "ContextGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implemented by + +- [`DefaultContextGenerator`](../classes/DefaultContextGenerator.md) + +## Methods + +### generate + +▸ **generate**(`message`, `parentEvent?`): `Promise`<[`Context`](Context.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------ | +| `message` | `string` | +| `parentEvent?` | [`Event`](Event.md) | + +#### Returns + +`Promise`<[`Context`](Context.md)\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:180](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L180) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/DefaultStreamToken.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/DefaultStreamToken.md new file mode 100644 index 0000000000000000000000000000000000000000..970b2fbd767db07fdae50d8c35482c7183a3f79e --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/DefaultStreamToken.md @@ -0,0 +1,57 @@ +--- +id: "DefaultStreamToken" +title: "Interface: DefaultStreamToken" +sidebar_label: "DefaultStreamToken" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### choices + +• **choices**: { `delta`: { `content?`: `null` \| `string` ; `role?`: `"function"` \| `"user"` \| `"assistant"` \| `"system"` \| `"tool"` } ; `finish_reason`: `null` \| `string` ; `index`: `number` }[] + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L29) + +--- + +### created + +• **created**: `number` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L27) + +--- + +### id + +• **id**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L25) + +--- + +### model + +• **model**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L28) + +--- + +### object + +• **object**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L26) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/Event.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/Event.md new file mode 100644 index 0000000000000000000000000000000000000000..696773d3240eb0358c67343dcc118d19712085a3 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/Event.md @@ -0,0 +1,47 @@ +--- +id: "Event" +title: "Interface: Event" +sidebar_label: "Event" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L13) + +--- + +### parentId + +• `Optional` **parentId**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L16) + +--- + +### tags + +• `Optional` **tags**: [`EventTag`](../#eventtag)[] + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L15) + +--- + +### type + +• **type**: [`EventType`](../#eventtype) + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L14) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ExactMatchFilter.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ExactMatchFilter.md new file mode 100644 index 0000000000000000000000000000000000000000..ff169ac4ebee93aa29f06a473768c68a32b73d0c --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ExactMatchFilter.md @@ -0,0 +1,37 @@ +--- +id: "ExactMatchFilter" +title: "Interface: ExactMatchFilter" +sidebar_label: "ExactMatchFilter" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### filterType + +• **filterType**: `"ExactMatch"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L22) + +--- + +### key + +• **key**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L23) + +--- + +### value + +• **value**: `string` \| `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L24) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/GenericFileSystem.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/GenericFileSystem.md new file mode 100644 index 0000000000000000000000000000000000000000..0ef256fe195b686230d75b0b96f0e8fd7d5a74ba --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/GenericFileSystem.md @@ -0,0 +1,100 @@ +--- +id: "GenericFileSystem" +title: "Interface: GenericFileSystem" +sidebar_label: "GenericFileSystem" +sidebar_position: 0 +custom_edit_url: null +--- + +A filesystem interface that is meant to be compatible with +the 'fs' module from Node.js. +Allows for the use of similar inteface implementation on +browsers. + +## Implemented by + +- [`InMemoryFileSystem`](../classes/InMemoryFileSystem.md) + +## Methods + +### access + +▸ **access**(`path`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L12) + +--- + +### mkdir + +▸ **mkdir**(`path`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L13) + +--- + +### readFile + +▸ **readFile**(`path`, `options?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L11) + +--- + +### writeFile + +▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `content` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L10) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/LLM.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/LLM.md new file mode 100644 index 0000000000000000000000000000000000000000..66b4d8395ff712a7a03ce56f282f86abe06c8088 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/LLM.md @@ -0,0 +1,120 @@ +--- +id: "LLM" +title: "Interface: LLM" +sidebar_label: "LLM" +sidebar_position: 0 +custom_edit_url: null +--- + +Unified language model interface + +## Implemented by + +- [`Anthropic`](../classes/Anthropic.md) +- [`LlamaDeuce`](../classes/LlamaDeuce.md) +- [`OpenAI`](../classes/OpenAI.md) +- [`Portkey`](../classes/Portkey.md) + +## Properties + +### hasStreaming + +• **hasStreaming**: `boolean` + +#### Defined in + +[packages/core/src/llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L68) + +--- + +### metadata + +• **metadata**: [`LLMMetadata`](LLMMetadata.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L66) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------ | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L75) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------ | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :------------------ | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L88) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------- | +| `messages` | [`ChatMessage`](ChatMessage.md)[] | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L100) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/LLMMetadata.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/LLMMetadata.md new file mode 100644 index 0000000000000000000000000000000000000000..facc2e5941d50574a563ac0d6c03225e25a88595 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/LLMMetadata.md @@ -0,0 +1,67 @@ +--- +id: "LLMMetadata" +title: "Interface: LLMMetadata" +sidebar_label: "LLMMetadata" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### contextWindow + +• **contextWindow**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L58) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L57) + +--- + +### model + +• **model**: `string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L54) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L55) + +--- + +### tokenizer + +• **tokenizer**: `undefined` \| [`CL100K_BASE`](../enums/Tokenizers.md#cl100k_base) + +#### Defined in + +[packages/core/src/llm/LLM.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L59) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/llm/LLM.ts#L56) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MessageContentDetail.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MessageContentDetail.md new file mode 100644 index 0000000000000000000000000000000000000000..a7fcbc9dec5148b7530ed510d1f82321ecfcaaae --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MessageContentDetail.md @@ -0,0 +1,43 @@ +--- +id: "MessageContentDetail" +title: "Interface: MessageContentDetail" +sidebar_label: "MessageContentDetail" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### image_url + +• `Optional` **image_url**: `Object` + +#### Type declaration + +| Name | Type | +| :---- | :------- | +| `url` | `string` | + +#### Defined in + +[packages/core/src/ChatEngine.ts:344](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L344) + +--- + +### text + +• `Optional` **text**: `string` + +#### Defined in + +[packages/core/src/ChatEngine.ts:343](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L343) + +--- + +### type + +• **type**: `"text"` \| `"image_url"` + +#### Defined in + +[packages/core/src/ChatEngine.ts:342](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ChatEngine.ts#L342) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MetadataFilters.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MetadataFilters.md new file mode 100644 index 0000000000000000000000000000000000000000..26d4780e9fefc368b5c1fd9eec737a05c3c0ee8f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MetadataFilters.md @@ -0,0 +1,17 @@ +--- +id: "MetadataFilters" +title: "Interface: MetadataFilters" +sidebar_label: "MetadataFilters" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### filters + +• **filters**: [`ExactMatchFilter`](ExactMatchFilter.md)[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L28) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MetadataInfo.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MetadataInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..61a5f818b8cf59b1d669115efddd65fc31f9dee8 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/MetadataInfo.md @@ -0,0 +1,37 @@ +--- +id: "MetadataInfo" +title: "Interface: MetadataInfo" +sidebar_label: "MetadataInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L40) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L38) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L39) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/NodeParser.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/NodeParser.md new file mode 100644 index 0000000000000000000000000000000000000000..f5a0a8e34be6f6ed49d5bbc9129fa894f7a3688c --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/NodeParser.md @@ -0,0 +1,37 @@ +--- +id: "NodeParser" +title: "Interface: NodeParser" +sidebar_label: "NodeParser" +sidebar_position: 0 +custom_edit_url: null +--- + +A NodeParser generates Nodes from Documents + +## Implemented by + +- [`SimpleNodeParser`](../classes/SimpleNodeParser.md) + +## Methods + +### getNodesFromDocuments + +▸ **getNodesFromDocuments**(`documents`): [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] + +Generates an array of nodes from an array of documents. + +#### Parameters + +| Name | Type | Description | +| :---------- | :------------------------------------------------------------------ | :------------------------------------ | +| `documents` | [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] | The documents to generate nodes from. | + +#### Returns + +[`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] + +An array of nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/NodeParser.ts#L86) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/NodeWithScore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/NodeWithScore.md new file mode 100644 index 0000000000000000000000000000000000000000..806b4f31f668e3e4141cee37cf8ebaac20e7de87 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/NodeWithScore.md @@ -0,0 +1,35 @@ +--- +id: "NodeWithScore" +title: "Interface: NodeWithScore<T>" +sidebar_label: "NodeWithScore" +sidebar_position: 0 +custom_edit_url: null +--- + +A node with a similarity score + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Properties + +### node + +• **node**: [`BaseNode`](../classes/BaseNode.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:327](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L327) + +--- + +### score + +• `Optional` **score**: `number` + +#### Defined in + +[packages/core/src/Node.ts:328](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L328) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/QueryEngineTool.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/QueryEngineTool.md new file mode 100644 index 0000000000000000000000000000000000000000..4344f63398b5f09372c1d9beebebb780a6bf27ad --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/QueryEngineTool.md @@ -0,0 +1,39 @@ +--- +id: "QueryEngineTool" +title: "Interface: QueryEngineTool" +sidebar_label: "QueryEngineTool" +sidebar_position: 0 +custom_edit_url: null +--- + +A Tool that uses a QueryEngine. + +## Hierarchy + +- [`BaseTool`](BaseTool.md) + + ↳ **`QueryEngineTool`** + +## Properties + +### metadata + +• **metadata**: [`ToolMetadata`](ToolMetadata.md) + +#### Inherited from + +[BaseTool](BaseTool.md).[metadata](BaseTool.md#metadata) + +#### Defined in + +[packages/core/src/Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Tool.ts#L12) + +--- + +### queryEngine + +• **queryEngine**: [`BaseQueryEngine`](BaseQueryEngine.md) + +#### Defined in + +[packages/core/src/Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Tool.ts#L19) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RefDocInfo.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RefDocInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..a4680b7d8f60b48a4dd97d48535d4d685738083a --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RefDocInfo.md @@ -0,0 +1,27 @@ +--- +id: "RefDocInfo" +title: "Interface: RefDocInfo" +sidebar_label: "RefDocInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### extraInfo + +• **extraInfo**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L12) + +--- + +### nodeIds + +• **nodeIds**: `string`[] + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/docStore/types.ts#L11) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RelatedNodeInfo.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RelatedNodeInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..9ce2b9e7f31a9e2ad57fe67025fe7da5d6e0c615 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RelatedNodeInfo.md @@ -0,0 +1,53 @@ +--- +id: "RelatedNodeInfo" +title: "Interface: RelatedNodeInfo<T>" +sidebar_label: "RelatedNodeInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Properties + +### hash + +• `Optional` **hash**: `string` + +#### Defined in + +[packages/core/src/Node.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L33) + +--- + +### metadata + +• **metadata**: `T` + +#### Defined in + +[packages/core/src/Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L32) + +--- + +### nodeId + +• **nodeId**: `string` + +#### Defined in + +[packages/core/src/Node.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L30) + +--- + +### nodeType + +• `Optional` **nodeType**: [`ObjectType`](../enums/ObjectType.md) + +#### Defined in + +[packages/core/src/Node.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Node.ts#L31) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RetrievalCallbackResponse.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RetrievalCallbackResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..9d9a728f65e1508310cb271bcc8dc45bba3e8e0f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/RetrievalCallbackResponse.md @@ -0,0 +1,47 @@ +--- +id: "RetrievalCallbackResponse" +title: "Interface: RetrievalCallbackResponse" +sidebar_label: "RetrievalCallbackResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseCallbackResponse` + + ↳ **`RetrievalCallbackResponse`** + +## Properties + +### event + +• **event**: [`Event`](Event.md) + +#### Inherited from + +BaseCallbackResponse.event + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L20) + +--- + +### nodes + +• **nodes**: [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L65) + +--- + +### query + +• **query**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L64) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContext.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContext.md new file mode 100644 index 0000000000000000000000000000000000000000..038bb6f3ca9414fab3dae8d41f007818db7fdbae --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContext.md @@ -0,0 +1,59 @@ +--- +id: "ServiceContext" +title: "Interface: ServiceContext" +sidebar_label: "ServiceContext" +sidebar_position: 0 +custom_edit_url: null +--- + +The ServiceContext is a collection of components that are used in different parts of the application. + +## Properties + +### callbackManager + +• **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L15) + +--- + +### embedModel + +• **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L13) + +--- + +### llm + +• **llm**: [`LLM`](LLM.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L11) + +--- + +### nodeParser + +• **nodeParser**: [`NodeParser`](NodeParser.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L14) + +--- + +### promptHelper + +• **promptHelper**: [`PromptHelper`](../classes/PromptHelper.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L12) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContextOptions.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContextOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..8807109c4b04dd42999a80115a0f31045be690b9 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContextOptions.md @@ -0,0 +1,77 @@ +--- +id: "ServiceContextOptions" +title: "Interface: ServiceContextOptions" +sidebar_label: "ServiceContextOptions" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L24) + +--- + +### chunkOverlap + +• `Optional` **chunkOverlap**: `number` + +#### Defined in + +[packages/core/src/ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L27) + +--- + +### chunkSize + +• `Optional` **chunkSize**: `number` + +#### Defined in + +[packages/core/src/ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L26) + +--- + +### embedModel + +• `Optional` **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L22) + +--- + +### llm + +• `Optional` **llm**: [`LLM`](LLM.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L20) + +--- + +### nodeParser + +• `Optional` **nodeParser**: [`NodeParser`](NodeParser.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L23) + +--- + +### promptHelper + +• `Optional` **promptHelper**: [`PromptHelper`](../classes/PromptHelper.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/ServiceContext.ts#L21) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StorageContext.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StorageContext.md new file mode 100644 index 0000000000000000000000000000000000000000..55bbf2b8a88a09d035a3a7972494a35819a9db83 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StorageContext.md @@ -0,0 +1,37 @@ +--- +id: "StorageContext" +title: "Interface: StorageContext" +sidebar_label: "StorageContext" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](../classes/BaseDocumentStore.md) + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/StorageContext.ts#L11) + +--- + +### indexStore + +• **indexStore**: [`BaseIndexStore`](../classes/BaseIndexStore.md) + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/StorageContext.ts#L12) + +--- + +### vectorStore + +• **vectorStore**: [`VectorStore`](VectorStore.md) + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/StorageContext.ts#L13) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StreamCallbackResponse.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StreamCallbackResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..ce7767471d9ac5743f646b9a88fc4b17ce227f70 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StreamCallbackResponse.md @@ -0,0 +1,57 @@ +--- +id: "StreamCallbackResponse" +title: "Interface: StreamCallbackResponse" +sidebar_label: "StreamCallbackResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseCallbackResponse` + + ↳ **`StreamCallbackResponse`** + +## Properties + +### event + +• **event**: [`Event`](Event.md) + +#### Inherited from + +BaseCallbackResponse.event + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L20) + +--- + +### index + +• **index**: `number` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L58) + +--- + +### isDone + +• `Optional` **isDone**: `boolean` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L59) + +--- + +### token + +• `Optional` **token**: [`DefaultStreamToken`](DefaultStreamToken.md) + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/callbacks/CallbackManager.ts#L60) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StructuredOutput.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StructuredOutput.md new file mode 100644 index 0000000000000000000000000000000000000000..8b5e5ae4ba52ae55105904373d988c6662fa1159 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/StructuredOutput.md @@ -0,0 +1,35 @@ +--- +id: "StructuredOutput" +title: "Interface: StructuredOutput<T>" +sidebar_label: "StructuredOutput" +sidebar_position: 0 +custom_edit_url: null +--- + +StructuredOutput is just a combo of the raw output and the parsed output. + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Properties + +### parsedOutput + +• **parsedOutput**: `T` + +#### Defined in + +[packages/core/src/OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L16) + +--- + +### rawOutput + +• **rawOutput**: `string` + +#### Defined in + +[packages/core/src/OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/OutputParser.ts#L15) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/SubQuestion.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/SubQuestion.md new file mode 100644 index 0000000000000000000000000000000000000000..4bcce432c294c439204a2fea8bd4309db38cb687 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/SubQuestion.md @@ -0,0 +1,27 @@ +--- +id: "SubQuestion" +title: "Interface: SubQuestion" +sidebar_label: "SubQuestion" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### subQuestion + +• **subQuestion**: `string` + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L15) + +--- + +### toolName + +• **toolName**: `string` + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/QuestionGenerator.ts#L16) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ToolMetadata.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ToolMetadata.md new file mode 100644 index 0000000000000000000000000000000000000000..e0325d90f615a9274005f23473a442000092a645 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/ToolMetadata.md @@ -0,0 +1,27 @@ +--- +id: "ToolMetadata" +title: "Interface: ToolMetadata" +sidebar_label: "ToolMetadata" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +[packages/core/src/Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Tool.ts#L4) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[packages/core/src/Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/Tool.ts#L5) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStore.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStore.md new file mode 100644 index 0000000000000000000000000000000000000000..0ff06c4634d3c311f02c6aa72177d3831172bb30 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStore.md @@ -0,0 +1,109 @@ +--- +id: "VectorStore" +title: "Interface: VectorStore" +sidebar_label: "VectorStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implemented by + +- [`MongoDBAtlasVectorSearch`](../classes/MongoDBAtlasVectorSearch.md) +- [`PGVectorStore`](../classes/PGVectorStore.md) +- [`SimpleVectorStore`](../classes/SimpleVectorStore.md) + +## Properties + +### isEmbeddingQuery + +• `Optional` **isEmbeddingQuery**: `boolean` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L61) + +--- + +### storesText + +• **storesText**: `boolean` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L60) + +## Methods + +### add + +▸ **add**(`embeddingResults`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------ | +| `embeddingResults` | [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L63) + +--- + +### client + +▸ **client**(): `any` + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L62) + +--- + +### delete + +▸ **delete**(`refDocId`, `deleteOptions?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `refDocId` | `string` | +| `deleteOptions?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L64) + +--- + +### query + +▸ **query**(`query`, `options?`): `Promise`<[`VectorStoreQueryResult`](VectorStoreQueryResult.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------- | +| `query` | [`VectorStoreQuery`](VectorStoreQuery.md) | +| `options?` | `any` | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](VectorStoreQueryResult.md)\> + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L65) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreInfo.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..f91c02e66d1e9f7451d7d14539ffb2905e4416d1 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreInfo.md @@ -0,0 +1,27 @@ +--- +id: "VectorStoreInfo" +title: "Interface: VectorStoreInfo" +sidebar_label: "VectorStoreInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### contentInfo + +• **contentInfo**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L45) + +--- + +### metadataInfo + +• **metadataInfo**: [`MetadataInfo`](MetadataInfo.md)[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L44) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuery.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuery.md new file mode 100644 index 0000000000000000000000000000000000000000..96c1dd6af84c83666e7d69e6d4e4526dba34167a --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuery.md @@ -0,0 +1,87 @@ +--- +id: "VectorStoreQuery" +title: "Interface: VectorStoreQuery" +sidebar_label: "VectorStoreQuery" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### alpha + +• `Optional` **alpha**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L54) + +--- + +### docIds + +• `Optional` **docIds**: `string`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L51) + +--- + +### filters + +• `Optional` **filters**: [`MetadataFilters`](MetadataFilters.md) + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L55) + +--- + +### mmrThreshold + +• `Optional` **mmrThreshold**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L56) + +--- + +### mode + +• **mode**: [`VectorStoreQueryMode`](../enums/VectorStoreQueryMode.md) + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L53) + +--- + +### queryEmbedding + +• `Optional` **queryEmbedding**: `number`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L49) + +--- + +### queryStr + +• `Optional` **queryStr**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L52) + +--- + +### similarityTopK + +• **similarityTopK**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L50) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQueryResult.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQueryResult.md new file mode 100644 index 0000000000000000000000000000000000000000..1c791ffc37e8ed4d5dfd1f4c52f6410a47ce445f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQueryResult.md @@ -0,0 +1,37 @@ +--- +id: "VectorStoreQueryResult" +title: "Interface: VectorStoreQueryResult" +sidebar_label: "VectorStoreQueryResult" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### ids + +• **ids**: `string`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L6) + +--- + +### nodes + +• `Optional` **nodes**: [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L4) + +--- + +### similarities + +• **similarities**: `number`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L5) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuerySpec.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuerySpec.md new file mode 100644 index 0000000000000000000000000000000000000000..892cd9254372c253ec01b467f81de3e4ee39f3fe --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuerySpec.md @@ -0,0 +1,37 @@ +--- +id: "VectorStoreQuerySpec" +title: "Interface: VectorStoreQuerySpec" +sidebar_label: "VectorStoreQuerySpec" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### filters + +• **filters**: [`ExactMatchFilter`](ExactMatchFilter.md)[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L33) + +--- + +### query + +• **query**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L32) + +--- + +### topK + +• `Optional` **topK**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/vectorStore/types.ts#L34) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/WalkableFileSystem.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/WalkableFileSystem.md new file mode 100644 index 0000000000000000000000000000000000000000..6dbe3533751744f647c3de588d1446b9c4b4c3c0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/WalkableFileSystem.md @@ -0,0 +1,47 @@ +--- +id: "WalkableFileSystem" +title: "Interface: WalkableFileSystem" +sidebar_label: "WalkableFileSystem" +sidebar_position: 0 +custom_edit_url: null +--- + +## Methods + +### readdir + +▸ **readdir**(`path`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L17) + +--- + +### stat + +▸ **stat**(`path`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/d613bbd/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/_category_.yml b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..43bec88cfa0aadb0e46f28701aad493dec3f2097 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/api/interfaces/_category_.yml @@ -0,0 +1,2 @@ +label: "Interfaces" +position: 4 \ No newline at end of file diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/concepts.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/concepts.md new file mode 100644 index 0000000000000000000000000000000000000000..6bb91a87f4ae2e146372164cb317593716ca5f5c --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/concepts.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 3 +--- + +# Concepts de haut niveau + +LlamaIndex.TS vous aide à construire des applications alimentées par LLM (par exemple, Q&R, chatbot) sur des données personnalisées. + +Dans ce guide des concepts de haut niveau, vous apprendrez : + +- comment un LLM peut répondre aux questions en utilisant vos propres données. +- les concepts clés et les modules de LlamaIndex.TS pour composer votre propre pipeline de requête. + +## Répondre aux questions sur vos données + +LlamaIndex utilise une méthode en deux étapes lors de l'utilisation d'un LLM avec vos données : + +1. **étape d'indexation** : préparation d'une base de connaissances, et +2. **étape de requête** : récupération du contexte pertinent à partir des connaissances pour aider le LLM à répondre à une question. + + + +Ce processus est également connu sous le nom de génération augmentée par récupération (RAG). + +LlamaIndex.TS fournit l'ensemble d'outils essentiel pour rendre ces deux étapes très faciles. + +Explorons chaque étape en détail. + +### Étape d'indexation + +LlamaIndex.TS vous aide à préparer la base de connaissances avec une suite de connecteurs de données et d'index. + + + +[**Chargeurs de données**](./modules/high_level/data_loader): +Un connecteur de données (c'est-à-dire un `Reader`) ingère des données à partir de différentes sources de données et de formats de données dans une représentation simple de `Document` (texte et métadonnées simples). + +[**Documents / Noeuds**](./modules/high_level/documents_and_nodes): Un `Document` est un conteneur générique pour n'importe quelle source de données - par exemple, un PDF, une sortie d'API, ou des données récupérées à partir d'une base de données. Un `Noeud` est l'unité atomique de données dans LlamaIndex et représente un "morceau" d'un `Document` source. C'est une représentation riche qui inclut des métadonnées et des relations (avec d'autres noeuds) pour permettre des opérations de récupération précises et expressives. + +[**Index de données**](./modules/high_level/data_index): +Une fois que vous avez ingéré vos données, LlamaIndex vous aide à indexer les données dans un format facile à récupérer. + +Sous le capot, LlamaIndex analyse les documents bruts en représentations intermédiaires, calcule des plongements vectoriels, et stocke vos données en mémoire ou sur disque. + +### Étape de requête + +Dans l'étape de requête, le pipeline de requête récupère le contexte le plus pertinent en fonction d'une requête utilisateur, +et le transmet au LLM (avec la requête) pour synthétiser une réponse. + +Cela donne au LLM des connaissances à jour qui ne sont pas dans ses données d'entraînement d'origine +(réduisant également l'hallucination). + +Le défi clé à l'étape de requête est la récupération, l'orchestration et le raisonnement sur (potentiellement de nombreuses) bases de connaissances. + +LlamaIndex fournit des modules composables qui vous aident à construire et intégrer des pipelines RAG pour Q&R (moteur de requête), chatbot (moteur de chat), ou en tant que partie d'un agent. + +Ces blocs de construction peuvent être personnalisés pour refléter les préférences de classement, ainsi que composés pour raisonner sur plusieurs bases de connaissances de manière structurée. + + + +#### Blocs de construction + +[**Récupérateurs**](./modules/low_level/retriever) : +Un récupérateur définit comment récupérer efficacement le contexte pertinent à partir d'une base de connaissances (c'est-à-dire un index) lorsqu'une requête est donnée. +La logique de récupération spécifique diffère pour différents indices, la plus populaire étant la récupération dense contre un index vectoriel. + +[**Synthétiseurs de réponse**](./modules/low_level/response_synthesizer) : +Un synthétiseur de réponse génère une réponse à partir d'un LLM, en utilisant une requête utilisateur et un ensemble donné de fragments de texte récupérés. + +#### Pipelines + +[**Moteurs de requête**](./modules/high_level/query_engine): +Un moteur de requête est un pipeline de bout en bout qui vous permet de poser des questions sur vos données. +Il prend une requête en langage naturel et renvoie une réponse, ainsi que le contexte de référence récupéré et transmis au LLM. + +[**Moteurs de chat**](./modules/high_level/chat_engine): +Un moteur de chat est un pipeline de bout en bout pour avoir une conversation avec vos données +(plusieurs allers-retours au lieu d'une seule question-réponse). diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/end_to_end.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/end_to_end.md new file mode 100644 index 0000000000000000000000000000000000000000..74a1cff7e89269fac31f3b656cd38d00e4137e52 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/end_to_end.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 4 +--- + +# Exemples de bout en bout + +Nous incluons plusieurs exemples de bout en bout en utilisant LlamaIndex.TS dans le référentiel. + +Consultez les exemples ci-dessous ou essayez-les et complétez-les en quelques minutes avec les tutoriels interactifs de Github Codespace fournis par Dev-Docs [ici](https://codespaces.new/team-dev-docs/lits-dev-docs-playground?devcontainer_path=.devcontainer%2Fjavascript_ltsquickstart%2Fdevcontainer.json): + +## [Chat Engine](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/chatEngine.ts) + +Lisez un fichier et discutez à ce sujet avec le LLM. + +## [Index de vecteurs](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndex.ts) + +Créez un index de vecteurs et interrogez-le. L'index de vecteurs utilisera des plongements pour récupérer les nœuds les plus pertinents les plus proches. Par défaut, le top k est 2. + +## [Index de résumé](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/summaryIndex.ts) + +Créez un index de liste et interrogez-le. Cet exemple utilise également le `LLMRetriever`, qui utilisera le LLM pour sélectionner les meilleurs nœuds à utiliser lors de la génération de la réponse. + +## [Enregistrer / Charger un index](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/storageContext.ts) + +Créez et chargez un index de vecteurs. La persistance sur le disque dans LlamaIndex.TS se fait automatiquement une fois qu'un objet de contexte de stockage est créé. + +## [Index de vecteur personnalisé](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexCustomize.ts) + +Créez un index de vecteur et interrogez-le, tout en configurant le `LLM`, le `ServiceContext` et le `similarity_top_k`. + +## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/openai.ts) + +Créez un OpenAI LLM et utilisez-le directement pour discuter. + +## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/llamadeuce.ts) + +Créez un Llama-2 LLM et utilisez-le directement pour discuter. + +## [SubQuestionQueryEngine](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts) + +Utilise le `SubQuestionQueryEngine`, qui divise les requêtes complexes en plusieurs questions, puis agrège une réponse à travers les réponses à toutes les sous-questions. + +## [Modules de bas niveau](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/lowlevel.ts) + +Cet exemple utilise plusieurs composants de bas niveau, ce qui élimine le besoin d'un moteur de requête réel. Ces composants peuvent être utilisés n'importe où, dans n'importe quelle application, ou personnalisés et sous-classés pour répondre à vos propres besoins. diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/environments.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/environments.md new file mode 100644 index 0000000000000000000000000000000000000000..cc3354a807a74564ce9761563e7ff1812604be44 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/environments.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 5 +--- + +# Environnements + +LlamaIndex prend actuellement en charge officiellement NodeJS 18 et NodeJS 20. + +## Routeur d'application NextJS + +Si vous utilisez des gestionnaires de route du routeur d'application NextJS ou des fonctions serverless, vous devrez utiliser le mode NodeJS : + +```js +export const runtime = "nodejs"; // par défaut +``` + +et vous devrez ajouter une exception pour pdf-parse dans votre fichier next.config.js + +```js +// next.config.js +/** @type {import('next').NextConfig} */ +const nextConfig = { + experimental: { + serverComponentsExternalPackages: ["pdf-parse"], // Met pdf-parse en mode NodeJS réel avec le routeur d'application NextJS + }, +}; + +module.exports = nextConfig; +``` diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/installation.mdx b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/installation.mdx new file mode 100644 index 0000000000000000000000000000000000000000..67efc8d6d5a1878c62e27e4a2603ec82ac0b0a43 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/installation.mdx @@ -0,0 +1,69 @@ +--- +sidebar_position: 1 +--- + + +# Installation et configuration + +Assurez-vous d'avoir NodeJS v18 ou une version supérieure. + + + +## Utilisation de create-llama + +La manière la plus simple de commencer avec LlamaIndex est d'utiliser `create-llama`. Cet outil CLI vous permet de démarrer rapidement la construction d'une nouvelle application LlamaIndex, avec tout configuré pour vous. + +Il vous suffit d'exécuter + +<Tabs> +<TabItem value="1" label="npm" default> + +```bash +npx create-llama@latest +``` + +</TabItem> +<TabItem value="2" label="Yarn"> + +```bash +yarn create llama +``` + +</TabItem> +<TabItem value="3" label="pnpm"> + +```bash +pnpm create llama@latest +``` + +</TabItem> +</Tabs> + +pour commencer. Une fois votre application générée, exécutez + +```bash npm2yarn +npm run dev +``` + +pour démarrer le serveur de développement. Vous pouvez ensuite visiter [http://localhost:3000](http://localhost:3000) pour voir votre application. + +## Installation depuis NPM + +```bash npm2yarn +npm install llamaindex +``` + + + +### Variables d'environnement + +Nos exemples utilisent OpenAI par défaut. Vous devrez configurer votre clé OpenAI comme ceci : + +```bash +export OPENAI_API_KEY="sk-......" # Remplacez par votre clé depuis https://platform.openai.com/account/api-keys +``` + +Si vous souhaitez le charger automatiquement à chaque fois, ajoutez-le à votre .zshrc/.bashrc. + +ATTENTION : ne publiez pas votre clé OpenAI dans le contrôle de version. + diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/introduction.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/introduction.md new file mode 100644 index 0000000000000000000000000000000000000000..4522d7bcadd447a35f90864e7ad4120945090ee4 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/introduction.md @@ -0,0 +1,56 @@ +--- +sidebar_position: 0 +slug: / +--- + +# Qu'est-ce que LlamaIndex.TS? + +LlamaIndex.TS est un framework de données pour les applications LLM permettant d'ingérer, de structurer et d'accéder à des données privées ou spécifiques à un domaine. Alors qu'un package python est également disponible (voir [ici](https://docs.llamaindex.ai/en/stable/)), LlamaIndex.TS offre des fonctionnalités de base dans un package simple, optimisé pour une utilisation avec TypeScript. + +## 🚀 Pourquoi LlamaIndex.TS? + +Fondamentalement, les LLM offrent une interface de langage naturel entre les humains et les données inférées. Les modèles largement disponibles sont pré-entraînés sur d'énormes quantités de données disponibles publiquement, de Wikipedia et des listes de diffusion à des manuels et du code source. + +Les applications construites sur les LLM nécessitent souvent d'augmenter ces modèles avec des données privées ou spécifiques à un domaine. Malheureusement, ces données peuvent être réparties dans des applications et des magasins de données cloisonnés. Elles se trouvent derrière des API, dans des bases de données SQL, ou piégées dans des PDF et des présentations. + +C'est là que **LlamaIndex.TS** intervient. + +## 🦙 Comment LlamaIndex.TS peut-il aider? + +LlamaIndex.TS fournit les outils suivants : + +- **Chargement de données** : ingérez directement vos données existantes en format `.txt`, `.pdf`, `.csv`, `.md` et `.docx` +- **Indexation des données** : structurez vos données dans des représentations intermédiaires faciles et performantes à consommer pour les LLM. +- **Moteurs** : fournissent un accès en langage naturel à vos données. Par exemple : + - Les moteurs de requête sont des interfaces de récupération puissantes pour une sortie augmentée par la connaissance. + - Les moteurs de chat sont des interfaces conversationnelles pour des interactions multi-messages, des échanges "aller-retour" avec vos données. + +## 👨👩👧👦 Pour qui est LlamaIndex? + +LlamaIndex.TS fournit un ensemble d'outils essentiels pour toute personne développant des applications LLM avec JavaScript et TypeScript. + +Notre API de haut niveau permet aux utilisateurs débutants d'utiliser LlamaIndex.TS pour ingérer et interroger leurs données. + +Pour des applications plus complexes, nos API de bas niveau permettent aux utilisateurs avancés de personnaliser et d'étendre n'importe quel module - connecteurs de données, index, récupérateurs et moteurs de requêtes - pour répondre à leurs besoins. + +## Pour commencer + +`npm install llamaindex` + +Notre documentation comprend des [Instructions d'installation](./installation) et un [Tutoriel de démarrage](./starter) pour construire votre première application. + +Une fois que vous êtes opérationnel, les [Concepts de haut niveau](./concepts) donnent un aperçu de l'architecture modulaire de LlamaIndex. Pour plus d'exemples pratiques, consultez nos [Tutoriels de bout en bout](./end_to_end). + +## 🗺️ Écosystème + +Pour télécharger ou contribuer, trouvez LlamaIndex sur : + +- Github : https://github.com/run-llama/LlamaIndexTS +- NPM : https://www.npmjs.com/package/llamaindex + +## Communauté + +Besoin d'aide ? Vous avez une suggestion de fonctionnalité ? Rejoignez la communauté LlamaIndex : + +- Twitter : https://twitter.com/llama_index +- Discord : https://discord.gg/dGcwcsnxhU diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md new file mode 100644 index 0000000000000000000000000000000000000000..e6cfcf1f966da56d188159058368b5a7ed9f02e0 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 4 +--- + +# ChatEngine (Moteur de discussion) + +Le moteur de discussion est un moyen rapide et simple de discuter avec les données de votre index. + +```typescript +const retriever = index.asRetriever(); +const chatEngine = new ContextChatEngine({ retriever }); + +// commencer la discussion +const response = await chatEngine.chat(query); +``` + +## Références de l'API + +- [ContextChatEngine](../../api/classes/ContextChatEngine) +- [CondenseQuestionChatEngine](../../api/classes/ContextChatEngine) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md new file mode 100644 index 0000000000000000000000000000000000000000..9788b5b5ac9746899f95512ac22bf061b43db6bd --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# Index + +Un index est le conteneur de base et l'organisation de vos données. LlamaIndex.TS prend en charge deux types d'index : + +- `VectorStoreIndex` - enverra les `Node`s les mieux classés au LLM lors de la génération d'une réponse. Le top-k par défaut est de 2. +- `SummaryIndex` - enverra chaque `Node` de l'index au LLM afin de générer une réponse. + +```typescript +import { Document, VectorStoreIndex } from "llamaindex"; + +const document = new Document({ text: "test" }); + +const index = await VectorStoreIndex.fromDocuments([document]); +``` + +## Référence de l'API + +- [SummaryIndex](../../api/classes/SummaryIndex) +- [VectorStoreIndex](../../api/classes/VectorStoreIndex) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md new file mode 100644 index 0000000000000000000000000000000000000000..36d21eb533d4e6db133120a9deda76e09fb0da94 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 1 +--- + +# Lecteur / Chargeur + +LlamaIndex.TS prend en charge le chargement facile de fichiers à partir de dossiers en utilisant la classe `SimpleDirectoryReader`. Actuellement, les fichiers `.txt`, `.pdf`, `.csv`, `.md` et `.docx` sont pris en charge, avec plus à venir dans le futur ! + +```typescript +import { SimpleDirectoryReader } from "llamaindex"; + +documents = new SimpleDirectoryReader().loadData("./data"); +``` + +## Référence de l'API + +- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md new file mode 100644 index 0000000000000000000000000000000000000000..65e5a44d66b6f543d9810b19997d5f1f5f18b7bc --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 0 +--- + +# Documents et Noeuds + +Les `Document`s et les `Node`s sont les éléments de base de tout index. Bien que l'API pour ces objets soit similaire, les objets `Document` représentent des fichiers entiers, tandis que les `Node`s sont des morceaux plus petits de ce document original, adaptés à un LLM et à une Q&R. + +```typescript +import { Document } from "llamaindex"; + +document = new Document({ text: "texte", metadata: { clé: "val" } }); +``` + +## Référence de l'API + +- [Document](../../api/classes/Document) +- [TextNode](../../api/classes/TextNode) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md new file mode 100644 index 0000000000000000000000000000000000000000..6d11783682cc1b69124d46ead4b4bb7a2e07285f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# Moteur de requête + +Un moteur de requête enveloppe un `Retriever` et un `ResponseSynthesizer` dans un pipeline, qui utilisera la chaîne de requête pour récupérer des nœuds, puis les enverra au LLM pour générer une réponse. + +```typescript +const queryEngine = index.asQueryEngine(); +const response = await queryEngine.query("chaîne de requête"); +``` + +## Moteur de requête de sous-question + +Le concept de base du moteur de requête de sous-question est de diviser une seule requête en plusieurs requêtes, d'obtenir une réponse pour chacune de ces requêtes, puis de combiner ces différentes réponses en une seule réponse cohérente pour l'utilisateur. Vous pouvez le considérer comme la technique de "réfléchir étape par étape" mais en itérant sur vos sources de données! + +### Pour commencer + +La manière la plus simple de commencer à essayer le Moteur de requête de sous-question est d'exécuter le fichier subquestion.ts dans [examples](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts). + +```bash +npx ts-node subquestion.ts +``` + +### Outils + +Le moteur de requête de sous-question est implémenté avec des Outils. L'idée de base des Outils est qu'ils sont des options exécutables pour le grand modèle de langage. Dans ce cas, notre moteur de requête de sous-question repose sur QueryEngineTool, qui, comme vous l'avez deviné, est un outil pour exécuter des requêtes sur un QueryEngine. Cela nous permet de donner au modèle une option pour interroger différents documents pour différentes questions, par exemple. Vous pourriez également imaginer que le moteur de requête de sous-question pourrait utiliser un Outil qui recherche quelque chose sur le web ou obtient une réponse en utilisant Wolfram Alpha. + +Vous pouvez en apprendre davantage sur les Outils en consultant la documentation Python de LlamaIndex https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html + +## Référence de l'API + +- [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine) +- [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine) +- [QueryEngineTool](../../api/interfaces/QueryEngineTool) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/index.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/index.md new file mode 100644 index 0000000000000000000000000000000000000000..fc314b0ab0e729ba8ea57113e37e252c05517a29 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/index.md @@ -0,0 +1,31 @@ +# Modules de base + +LlamaIndex.TS propose plusieurs modules de base, séparés en modules de haut niveau pour démarrer rapidement et en modules de bas niveau pour personnaliser les composants clés selon vos besoins. + +## Modules de haut niveau + +- [**Document**](./high_level/documents_and_nodes): Un document représente un fichier texte, un fichier PDF ou toute autre donnée contiguë. + +- [**Node**](./high_level/documents_and_nodes): La brique de construction de données de base. Le plus souvent, il s'agit de parties du document divisées en morceaux gérables assez petits pour être intégrées dans un modèle d'incorporation et LLM. + +- [**Reader/Loader**](./high_level/data_loader): Un lecteur ou un chargeur est quelque chose qui prend un document dans le monde réel et le transforme en une classe Document qui peut ensuite être utilisée dans votre Index et vos requêtes. Nous prenons actuellement en charge les fichiers texte brut et les PDF, avec de nombreux autres à venir. + +- [**Indexes**](./high_level/data_index): les index stockent les nœuds et les incorporations de ces nœuds. + +- [**QueryEngine**](./high_level/query_engine): Les moteurs de requête génèrent la requête que vous saisissez et vous renvoient le résultat. Les moteurs de requête combinent généralement une invite pré-construite avec des nœuds sélectionnés dans votre Index pour donner au LLM le contexte dont il a besoin pour répondre à votre requête. + +- [**ChatEngine**](./high_level/chat_engine): Un ChatEngine vous aide à construire un chatbot qui interagira avec vos Index. + +## Module de bas niveau + +- [**LLM**](./low_level/llm): La classe LLM est une interface unifiée sur un grand fournisseur de modèle de langage tel que OpenAI GPT-4, Anthropic Claude, ou Meta LLaMA. Vous pouvez la sous-classer pour écrire un connecteur vers votre propre grand modèle de langage. + +- [**Embedding**](./low_level/embedding): Un embedding est représenté par un vecteur de nombres flottants. Le modèle d'embedding par défaut d'OpenAI est text-embedding-ada-002 et chaque embedding qu'il génère est composé de 1 536 nombres flottants. Un autre modèle d'embedding populaire est BERT qui utilise 768 nombres flottants pour représenter chaque nœud. Nous fournissons un certain nombre d'utilitaires pour travailler avec les embeddings, y compris 3 options de calcul de similarité et une pertinence marginale maximale. + +- [**TextSplitter/NodeParser**](./low_level/node_parser): Les stratégies de découpe de texte sont incroyablement importantes pour l'efficacité globale de la recherche d'embedding. Actuellement, bien que nous ayons une valeur par défaut, il n'y a pas de solution universelle. Selon les documents sources, vous voudrez peut-être utiliser différentes tailles et stratégies de découpe. Actuellement, nous prenons en charge la découpe par taille fixe, la découpe par taille fixe avec des sections chevauchantes, la découpe par phrase et la découpe par paragraphe. Le découpeur de texte est utilisé par le NodeParser lors de la découpe des `Document`s en `Node`s. + +- [**Retriever**](./low_level/retriever): Le Retriever est ce qui choisit effectivement les Nodes à récupérer dans l'index. Ici, vous pouvez essayer de récupérer plus ou moins de Nodes par requête, changer votre fonction de similarité, ou créer votre propre retriever pour chaque cas d'utilisation individuel dans votre application. Par exemple, vous pouvez souhaiter avoir un retriever séparé pour le contenu de code par rapport au contenu textuel. + +- [**ResponseSynthesizer**](./low_level/response_synthesizer): Le ResponseSynthesizer est responsable de prendre une chaîne de requête et d'utiliser une liste de `Node`s pour générer une réponse. Cela peut prendre de nombreuses formes, comme itérer sur tout le contexte et affiner une réponse, ou construire un arbre de résumés et renvoyer le résumé principal. + +- [**Storage**](./low_level/storage): À un moment donné, vous voudrez stocker vos index, données et vecteurs au lieu de relancer les modèles d'embedding à chaque fois. IndexStore, DocStore, VectorStore et KVStore sont des abstractions qui vous permettent de le faire. Ensemble, ils forment le StorageContext. Actuellement, nous vous permettons de persister vos embeddings dans des fichiers sur le système de fichiers (ou un système de fichiers virtuel en mémoire), mais nous ajoutons également activement des intégrations aux bases de données de vecteurs. diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/embedding.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/embedding.md new file mode 100644 index 0000000000000000000000000000000000000000..559f67776ded213d96468f762412a592b6ee8c54 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/embedding.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +--- + +# Intégration + +Le modèle d'intégration dans LlamaIndex est responsable de la création de représentations numériques du texte. Par défaut, LlamaIndex utilisera le modèle `text-embedding-ada-002` d'OpenAI. + +Cela peut être explicitement défini dans l'objet `ServiceContext`. + +```typescript +import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex"; + +const openaiEmbeds = new OpenAIEmbedding(); + +const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds }); +``` + +## Référence de l'API + +- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding) +- [ServiceContext](../../api/interfaces/ServiceContext) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/llm.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/llm.md new file mode 100644 index 0000000000000000000000000000000000000000..f773e01ecf9fdf0e9d381857e325b7f323036e13 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/llm.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 0 +--- + +# LLM + +Le LLM est responsable de la lecture du texte et de la génération de réponses en langage naturel aux requêtes. Par défaut, LlamaIndex.TS utilise `gpt-3.5-turbo`. + +Le LLM peut être explicitement défini dans l'objet `ServiceContext`. + +```typescript +import { OpenAI, serviceContextFromDefaults } from "llamaindex"; + +const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 }); + +const serviceContext = serviceContextFromDefaults({ llm: openaiLLM }); +``` + +## Référence de l'API + +- [OpenAI](../../api/classes/OpenAI) +- [ServiceContext](../../api/interfaces/ServiceContext) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/node_parser.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/node_parser.md new file mode 100644 index 0000000000000000000000000000000000000000..bba8939e7f5cbc54d07d633c9c234216e7043d1f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/node_parser.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 3 +--- + +# NodeParser + +Le `NodeParser` dans LlamaIndex est responsable de la division des objets `Document` en objets `Node` plus gérables. Lorsque vous appelez `.fromDocuments()`, le `NodeParser` du `ServiceContext` est utilisé pour le faire automatiquement pour vous. Alternativement, vous pouvez l'utiliser pour diviser les documents à l'avance. + +```typescript +import { Document, SimpleNodeParser } from "llamaindex"; + +const nodeParser = new SimpleNodeParser(); +const nodes = nodeParser.getNodesFromDocuments([ + new Document({ text: "J'ai 10 ans. John a 20 ans." }), +]); +``` + +## TextSplitter + +Le diviseur de texte sous-jacent divisera le texte par phrases. Il peut également être utilisé en tant que module autonome pour diviser du texte brut. + +```typescript +import { SentenceSplitter } from "llamaindex"; + +const splitter = new SentenceSplitter({ chunkSize: 1 }); + +const textSplits = splitter.splitText("Bonjour le monde"); +``` + +## Référence de l'API + +- [SimpleNodeParser](../../api/classes/SimpleNodeParser) +- [SentenceSplitter](../../api/classes/SentenceSplitter) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/response_synthesizer.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/response_synthesizer.md new file mode 100644 index 0000000000000000000000000000000000000000..c373fc340ff4e5f0668e6600bb0fbe73ff96d41f --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/response_synthesizer.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 6 +--- + +# ResponseSynthesizer + +Le ResponseSynthesizer est responsable de l'envoi de la requête, des nœuds et des modèles de prompt au LLM pour générer une réponse. Il existe quelques modes clés pour générer une réponse : + +- `Refine` : "créer et affiner" une réponse en passant séquentiellement par chaque fragment de texte récupéré. Cela fait un appel LLM séparé par nœud. Bon pour des réponses plus détaillées. +- `CompactAndRefine` (par défaut) : "compacter" le prompt lors de chaque appel LLM en insérant autant de fragments de texte que possible dans la taille de prompt maximale. S'il y a trop de fragments à insérer dans un seul prompt, "créer et affiner" une réponse en passant par plusieurs prompts compacts. Identique à `refine`, mais devrait entraîner moins d'appels LLM. +- `TreeSummarize` : Étant donné un ensemble de fragments de texte et la requête, construire récursivement un arbre et renvoyer le nœud racine comme réponse. Bon à des fins de résumé. +- `SimpleResponseBuilder` : Étant donné un ensemble de fragments de texte et la requête, appliquer la requête à chaque fragment de texte tout en accumulant les réponses dans un tableau. Renvoie une chaîne concaténée de toutes les réponses. Bon lorsque vous devez exécuter la même requête séparément contre chaque fragment de texte. + +```typescript +import { NodeWithScore, ResponseSynthesizer, TextNode } from "llamaindex"; + +const responseSynthesizer = new ResponseSynthesizer(); + +const nodesWithScore: NodeWithScore[] = [ + { + node: new TextNode({ text: "J'ai 10 ans." }), + score: 1, + }, + { + node: new TextNode({ text: "John a 20 ans." }), + score: 0.5, + }, +]; + +const response = await responseSynthesizer.synthesize( + "Quel âge ai-je ?", + nodesWithScore, +); +console.log(response.response); +``` + +## Référence de l'API + +- [ResponseSynthesizer](../../api/classes/ResponseSynthesizer) +- [Refine](../../api/classes/Refine) +- [CompactAndRefine](../../api/classes/CompactAndRefine) +- [TreeSummarize](../../api/classes/TreeSummarize) +- [SimpleResponseBuilder](../../api/classes/SimpleResponseBuilder) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md new file mode 100644 index 0000000000000000000000000000000000000000..c762bfd489be38f14273f25a13e9af171532cbdf --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 5 +--- + +# Retriever + +Un retriever dans LlamaIndex est ce qui est utilisé pour récupérer les `Node`s à partir d'un index en utilisant une chaîne de requête. Un `VectorIndexRetriever` récupérera les nœuds les plus similaires les plus proches. Pendant ce temps, un `SummaryIndexRetriever` récupérera tous les nœuds, peu importe la requête. + +```typescript +const retriever = vector_index.asRetriever(); +retriever.similarityTopK = 3; + +// Récupérer les nœuds ! +const nodesWithScore = await retriever.retrieve("chaîne de requête"); +``` + +## Référence de l'API + +- [SummaryIndexRetriever](../../api/classes/SummaryIndexRetriever) +- [SummaryIndexLLMRetriever](../../api/classes/SummaryIndexLLMRetriever) +- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/storage.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/storage.md new file mode 100644 index 0000000000000000000000000000000000000000..272d3f5aa2ddf2df9cc21aa18cef0e92c03e457b --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/modules/low_level/storage.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 7 +--- + +# Stockage + +Le stockage dans LlamaIndex.TS fonctionne automatiquement une fois que vous avez configuré un objet `StorageContext`. Il vous suffit de configurer le `persistDir` et de l'attacher à un index. + +Actuellement, seule la sauvegarde et le chargement depuis le disque sont pris en charge, avec des intégrations futures prévues ! + +```typescript +import { Document, VectorStoreIndex, storageContextFromDefaults } from "./src"; + +const storageContext = await storageContextFromDefaults({ + persistDir: "./storage", +}); + +const document = new Document({ text: "Test Text" }); +const index = await VectorStoreIndex.fromDocuments([document], { + storageContext, +}); +``` + +## Référence de l'API + +- [StorageContext](../../api/interfaces/StorageContext) diff --git a/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/starter.md b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/starter.md new file mode 100644 index 0000000000000000000000000000000000000000..6757694043d2f85621b80ee4363fa4d74260aa44 --- /dev/null +++ b/apps/docs/i18n/fr/docusaurus-plugin-content-docs/current/starter.md @@ -0,0 +1,56 @@ +--- +sidebar_position: 2 +--- + +# Tutoriel de Démarrage + +Une fois que vous avez [installé LlamaIndex.TS en utilisant NPM](installation) et configuré votre clé OpenAI, vous êtes prêt à démarrer votre première application : + +Dans un nouveau dossier : + +```bash npm2yarn +npm install typescript +npm install @types/node +npx tsc --init # si nécessaire +``` + +Créez le fichier `example.ts`. Ce code chargera des données d'exemple, créera un document, les indexera (ce qui crée des embeddings en utilisant OpenAI), puis créera un moteur de requête pour répondre aux questions sur les données. + +```ts +// example.ts +import fs from "fs/promises"; +import { Document, VectorStoreIndex } from "llamaindex"; + +async function main() { + // Charger l'essai depuis abramov.txt dans Node + const essai = await fs.readFile( + "node_modules/llamaindex/examples/abramov.txt", + "utf-8", + ); + + // Créer un objet Document avec l'essai + const document = new Document({ text: essai }); + + // Diviser le texte et créer des embeddings. Les stocker dans un VectorStoreIndex + const index = await VectorStoreIndex.fromDocuments([document]); + + // Interroger l'index + const moteurRequete = index.asQueryEngine(); + const réponse = await moteurRequete.query( + "Qu'a fait l'auteur à l'université ?", + ); + + // Afficher la réponse + console.log(réponse.toString()); +} + +main(); +``` + +Ensuite, vous pouvez l'exécuter en utilisant + +```bash +npx ts-node example.ts +``` + +Prêt à en apprendre davantage ? Consultez notre espace de jeu NextJS sur https://llama-playground.vercel.app/. Le code source est disponible sur https://github.com/run-llama/ts-playground diff --git a/apps/docs/i18n/zh-Hans/code.json b/apps/docs/i18n/zh-Hans/code.json new file mode 100644 index 0000000000000000000000000000000000000000..bec284f0e3115465cbd34534d2a1cb046921e30c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/code.json @@ -0,0 +1,404 @@ +{ + "theme.ErrorPageContent.title": { + "message": "页面已崩溃。", + "description": "The title of the fallback page when the page crashed" + }, + "theme.NotFound.title": { + "message": "找不到页面", + "description": "The title of the 404 page" + }, + "theme.NotFound.p1": { + "message": "我们找不到您要找的页面。", + "description": "The first paragraph of the 404 page" + }, + "theme.NotFound.p2": { + "message": "请联系原始链接来源网站的所有者,并告知他们链接已损坏。", + "description": "The 2nd paragraph of the 404 page" + }, + "theme.admonition.note": { + "message": "备注", + "description": "The default label used for the Note admonition (:::note)" + }, + "theme.admonition.tip": { + "message": "提示", + "description": "The default label used for the Tip admonition (:::tip)" + }, + "theme.admonition.danger": { + "message": "危险", + "description": "The default label used for the Danger admonition (:::danger)" + }, + "theme.admonition.info": { + "message": "信息", + "description": "The default label used for the Info admonition (:::info)" + }, + "theme.admonition.caution": { + "message": "警告", + "description": "The default label used for the Caution admonition (:::caution)" + }, + "theme.BackToTopButton.buttonAriaLabel": { + "message": "回到顶部", + "description": "The ARIA label for the back to top button" + }, + "theme.blog.paginator.navAriaLabel": { + "message": "博文列表分页导航", + "description": "The ARIA label for the blog pagination" + }, + "theme.blog.paginator.newerEntries": { + "message": "较新的博文", + "description": "The label used to navigate to the newer blog posts page (previous page)" + }, + "theme.blog.paginator.olderEntries": { + "message": "较旧的博文", + "description": "The label used to navigate to the older blog posts page (next page)" + }, + "theme.blog.post.paginator.navAriaLabel": { + "message": "博文分页导航", + "description": "The ARIA label for the blog posts pagination" + }, + "theme.blog.post.paginator.newerPost": { + "message": "较新一篇", + "description": "The blog post button label to navigate to the newer/previous post" + }, + "theme.blog.post.paginator.olderPost": { + "message": "较旧一篇", + "description": "The blog post button label to navigate to the older/next post" + }, + "theme.blog.archive.title": { + "message": "历史博文", + "description": "The page & hero title of the blog archive page" + }, + "theme.blog.archive.description": { + "message": "历史博文", + "description": "The page & hero description of the blog archive page" + }, + "theme.blog.post.plurals": { + "message": "{count} 篇博文", + "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.blog.tagTitle": { + "message": "{nPosts} 含有标签「{tagName}」", + "description": "The title of the page for a blog tag" + }, + "theme.tags.tagsPageLink": { + "message": "查看所有标签", + "description": "The label of the link targeting the tag list page" + }, + "theme.colorToggle.ariaLabel": { + "message": "切换浅色/暗黑模式(当前为{mode})", + "description": "The ARIA label for the navbar color mode toggle" + }, + "theme.colorToggle.ariaLabel.mode.dark": { + "message": "暗黑模式", + "description": "The name for the dark color mode" + }, + "theme.colorToggle.ariaLabel.mode.light": { + "message": "浅色模式", + "description": "The name for the light color mode" + }, + "theme.docs.breadcrumbs.navAriaLabel": { + "message": "页面路径", + "description": "The ARIA label for the breadcrumbs" + }, + "theme.docs.DocCard.categoryDescription": { + "message": "{count} 个项目", + "description": "The default description for a category card in the generated index about how many items this category includes" + }, + "theme.docs.paginator.navAriaLabel": { + "message": "文件选项卡", + "description": "The ARIA label for the docs pagination" + }, + "theme.docs.paginator.previous": { + "message": "上一页", + "description": "The label used to navigate to the previous doc" + }, + "theme.docs.paginator.next": { + "message": "下一页", + "description": "The label used to navigate to the next doc" + }, + "theme.docs.tagDocListPageTitle.nDocsTagged": { + "message": "{count} 篇文档带有标签", + "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.tagDocListPageTitle": { + "message": "{nDocsTagged}「{tagName}」", + "description": "The title of the page for a docs tag" + }, + "theme.docs.versionBadge.label": { + "message": "版本:{versionLabel}" + }, + "theme.docs.versions.unreleasedVersionLabel": { + "message": "此为 {siteTitle} {versionLabel} 版尚未发行的文档。", + "description": "The label used to tell the user that he's browsing an unreleased doc version" + }, + "theme.docs.versions.unmaintainedVersionLabel": { + "message": "此为 {siteTitle} {versionLabel} 版的文档,现已不再积极维护。", + "description": "The label used to tell the user that he's browsing an unmaintained doc version" + }, + "theme.docs.versions.latestVersionSuggestionLabel": { + "message": "最新的文档请参阅 {latestVersionLink} ({versionLabel})。", + "description": "The label used to tell the user to check the latest version" + }, + "theme.docs.versions.latestVersionLinkLabel": { + "message": "最新版本", + "description": "The label used for the latest version suggestion link label" + }, + "theme.common.editThisPage": { + "message": "编辑此页", + "description": "The link label to edit the current page" + }, + "theme.common.headingLinkTitle": { + "message": "{heading}的直接链接", + "description": "Title for link to heading" + }, + "theme.lastUpdated.atDate": { + "message": "于 {date} ", + "description": "The words used to describe on which date a page has been last updated" + }, + "theme.lastUpdated.byUser": { + "message": "由 {user} ", + "description": "The words used to describe by who the page has been last updated" + }, + "theme.lastUpdated.lastUpdatedAtBy": { + "message": "最后{byUser}{atDate}更新", + "description": "The sentence used to display when a page has been last updated, and by who" + }, + "theme.navbar.mobileVersionsDropdown.label": { + "message": "选择版本", + "description": "The label for the navbar versions dropdown on mobile view" + }, + "theme.tags.tagsListLabel": { + "message": "标签:", + "description": "The label alongside a tag list" + }, + "theme.AnnouncementBar.closeButtonAriaLabel": { + "message": "关闭", + "description": "The ARIA label for close button of announcement bar" + }, + "theme.blog.sidebar.navAriaLabel": { + "message": "最近博文导航", + "description": "The ARIA label for recent posts in the blog sidebar" + }, + "theme.CodeBlock.copied": { + "message": "复制成功", + "description": "The copied button label on code blocks" + }, + "theme.CodeBlock.copyButtonAriaLabel": { + "message": "复制代码到剪贴板", + "description": "The ARIA label for copy code blocks button" + }, + "theme.CodeBlock.copy": { + "message": "复制", + "description": "The copy button label on code blocks" + }, + "theme.CodeBlock.wordWrapToggle": { + "message": "切换自动换行", + "description": "The title attribute for toggle word wrapping button of code block lines" + }, + "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { + "message": "打开/收起侧边栏菜单「{label}」", + "description": "The ARIA label to toggle the collapsible sidebar category" + }, + "theme.NavBar.navAriaLabel": { + "message": "主导航", + "description": "The ARIA label for the main navigation" + }, + "theme.navbar.mobileLanguageDropdown.label": { + "message": "选择语言", + "description": "The label for the mobile language switcher dropdown" + }, + "theme.TOCCollapsible.toggleButtonLabel": { + "message": "本页总览", + "description": "The label used by the button on the collapsible TOC component" + }, + "theme.blog.post.readMore": { + "message": "阅读更多", + "description": "The label used in blog post item excerpts to link to full blog posts" + }, + "theme.blog.post.readMoreLabel": { + "message": "阅读 {title} 的全文", + "description": "The ARIA label for the link to full blog posts from excerpts" + }, + "theme.blog.post.readingTime.plurals": { + "message": "阅读需 {readingTime} 分钟", + "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.breadcrumbs.home": { + "message": "主页面", + "description": "The ARIA label for the home page in the breadcrumbs" + }, + "theme.docs.sidebar.collapseButtonTitle": { + "message": "收起侧边栏", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.collapseButtonAriaLabel": { + "message": "收起侧边栏", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "文档侧边栏", + "description": "The ARIA label for the sidebar navigation" + }, + "theme.docs.sidebar.closeSidebarButtonAriaLabel": { + "message": "关闭导航栏", + "description": "The ARIA label for close button of mobile sidebar" + }, + "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { + "message": "← 回到主菜单", + "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" + }, + "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { + "message": "切换导航栏", + "description": "The ARIA label for hamburger menu button of mobile navigation" + }, + "theme.docs.sidebar.expandButtonTitle": { + "message": "展开侧边栏", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.docs.sidebar.expandButtonAriaLabel": { + "message": "展开侧边栏", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.SearchBar.seeAll": { + "message": "查看全部 {count} 个结果" + }, + "theme.SearchPage.documentsFound.plurals": { + "message": "找到 {count} 份文件", + "description": "Pluralized label for \"{count} documents found\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.SearchPage.existingResultsTitle": { + "message": "「{query}」的搜索结果", + "description": "The search page title for non-empty query" + }, + "theme.SearchPage.emptyResultsTitle": { + "message": "在文档中搜索", + "description": "The search page title for empty query" + }, + "theme.SearchPage.inputPlaceholder": { + "message": "在此输入搜索字词", + "description": "The placeholder for search page input" + }, + "theme.SearchPage.inputLabel": { + "message": "搜索", + "description": "The ARIA label for search page input" + }, + "theme.SearchPage.algoliaLabel": { + "message": "通过 Algolia 搜索", + "description": "The ARIA label for Algolia mention" + }, + "theme.SearchPage.noResultsText": { + "message": "未找到任何结果", + "description": "The paragraph for empty search result" + }, + "theme.SearchPage.fetchingNewResults": { + "message": "正在获取新的搜索结果...", + "description": "The paragraph for fetching new search results" + }, + "theme.SearchBar.label": { + "message": "搜索", + "description": "The ARIA label and placeholder for search button" + }, + "theme.SearchModal.searchBox.resetButtonTitle": { + "message": "清除查询", + "description": "The label and ARIA label for search box reset button" + }, + "theme.SearchModal.searchBox.cancelButtonText": { + "message": "取消", + "description": "The label and ARIA label for search box cancel button" + }, + "theme.SearchModal.startScreen.recentSearchesTitle": { + "message": "最近搜索", + "description": "The title for recent searches" + }, + "theme.SearchModal.startScreen.noRecentSearchesText": { + "message": "没有最近搜索", + "description": "The text when no recent searches" + }, + "theme.SearchModal.startScreen.saveRecentSearchButtonTitle": { + "message": "保存这个搜索", + "description": "The label for save recent search button" + }, + "theme.SearchModal.startScreen.removeRecentSearchButtonTitle": { + "message": "从历史记录中删除这个搜索", + "description": "The label for remove recent search button" + }, + "theme.SearchModal.startScreen.favoriteSearchesTitle": { + "message": "收藏", + "description": "The title for favorite searches" + }, + "theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle": { + "message": "从收藏列表中删除这个搜索", + "description": "The label for remove favorite search button" + }, + "theme.SearchModal.errorScreen.titleText": { + "message": "无法获取结果", + "description": "The title for error screen of search modal" + }, + "theme.SearchModal.errorScreen.helpText": { + "message": "你可能需要检查网络连接。", + "description": "The help text for error screen of search modal" + }, + "theme.SearchModal.footer.selectText": { + "message": "选中", + "description": "The explanatory text of the action for the enter key" + }, + "theme.SearchModal.footer.selectKeyAriaLabel": { + "message": "Enter 键", + "description": "The ARIA label for the Enter key button that makes the selection" + }, + "theme.SearchModal.footer.navigateText": { + "message": "导航", + "description": "The explanatory text of the action for the Arrow up and Arrow down key" + }, + "theme.SearchModal.footer.navigateUpKeyAriaLabel": { + "message": "向上键", + "description": "The ARIA label for the Arrow up key button that makes the navigation" + }, + "theme.SearchModal.footer.navigateDownKeyAriaLabel": { + "message": "向下键", + "description": "The ARIA label for the Arrow down key button that makes the navigation" + }, + "theme.SearchModal.footer.closeText": { + "message": "关闭", + "description": "The explanatory text of the action for Escape key" + }, + "theme.SearchModal.footer.closeKeyAriaLabel": { + "message": "Esc 键", + "description": "The ARIA label for the Escape key button that close the modal" + }, + "theme.SearchModal.footer.searchByText": { + "message": "搜索提供", + "description": "The text explain that the search is making by Algolia" + }, + "theme.SearchModal.noResultsScreen.noResultsText": { + "message": "没有结果:", + "description": "The text explains that there are no results for the following search" + }, + "theme.SearchModal.noResultsScreen.suggestedQueryText": { + "message": "试试搜索", + "description": "The text for the suggested query when no results are found for the following search" + }, + "theme.SearchModal.noResultsScreen.reportMissingResultsText": { + "message": "认为这个查询应该有结果?", + "description": "The text for the question where the user thinks there are missing results" + }, + "theme.SearchModal.noResultsScreen.reportMissingResultsLinkText": { + "message": "请告知我们。", + "description": "The text for the link to report missing results" + }, + "theme.SearchModal.placeholder": { + "message": "搜索文档", + "description": "The placeholder of the input of the DocSearch pop-up modal" + }, + "theme.ErrorPageContent.tryAgain": { + "message": "重试", + "description": "The label of the button to try again rendering when the React error boundary captures an error" + }, + "theme.common.skipToMainContent": { + "message": "跳到主要内容", + "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" + }, + "theme.tags.tagsPageTitle": { + "message": "标签", + "description": "The title of the tag list page" + } +} diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json new file mode 100644 index 0000000000000000000000000000000000000000..8e1dfc503ce57244c64da82555b1a21710b6278b --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current.json @@ -0,0 +1,34 @@ +{ + "version.label": { + "message": "Next", + "description": "The label for version current" + }, + "sidebar.mySidebar.category.Modules": { + "message": "Modules", + "description": "The label for category Modules in sidebar mySidebar" + }, + "sidebar.mySidebar.category.High-Level Modules": { + "message": "High-Level Modules", + "description": "The label for category High-Level Modules in sidebar mySidebar" + }, + "sidebar.mySidebar.category.Low-Level Modules": { + "message": "Low-Level Modules", + "description": "The label for category Low-Level Modules in sidebar mySidebar" + }, + "sidebar.mySidebar.category.API": { + "message": "API", + "description": "The label for category API in sidebar mySidebar" + }, + "sidebar.mySidebar.category.Enumerations": { + "message": "Enumerations", + "description": "The label for category Enumerations in sidebar mySidebar" + }, + "sidebar.mySidebar.category.Classes": { + "message": "Classes", + "description": "The label for category Classes in sidebar mySidebar" + }, + "sidebar.mySidebar.category.Interfaces": { + "message": "Interfaces", + "description": "The label for category Interfaces in sidebar mySidebar" + } +} diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/indexing.jpg b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/indexing.jpg new file mode 100644 index 0000000000000000000000000000000000000000..8672967213caf28fb27682b6b9e2e5111beb9aaa Binary files /dev/null and b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/indexing.jpg differ diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/querying.jpg b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/querying.jpg new file mode 100644 index 0000000000000000000000000000000000000000..3c241bdda5ba98d3f3ee2e163b9f19280c5c7503 Binary files /dev/null and b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/querying.jpg differ diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/rag.jpg b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/rag.jpg new file mode 100644 index 0000000000000000000000000000000000000000..b68eca2564f8535b33d9ed6d4ce4d4410d2a0698 Binary files /dev/null and b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/_static/concepts/rag.jpg differ diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..79eb4b8a2939888be2393145205ffe6bc5fea186 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/_category_.yml @@ -0,0 +1,2 @@ +label: "API" +position: 6 \ No newline at end of file diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Anthropic.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Anthropic.md new file mode 100644 index 0000000000000000000000000000000000000000..c6dea089c6337cbfdec24d24f792c4ee26597585 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Anthropic.md @@ -0,0 +1,318 @@ +--- +id: "Anthropic" +title: "Class: Anthropic" +sidebar_label: "Anthropic" +sidebar_position: 0 +custom_edit_url: null +--- + +Anthropic LLM implementation + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new Anthropic**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------- | +| `init?` | `Partial`<[`Anthropic`](Anthropic.md)\> | + +#### Defined in + +[packages/core/src/llm/LLM.ts:667](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L667) + +## Properties + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:660](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L660) + +--- + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:665](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L665) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` = `true` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:651](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L651) + +--- + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:661](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L661) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:657](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L657) + +--- + +### model + +• **model**: `"claude-2"` \| `"claude-instant-1"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:654](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L654) + +--- + +### session + +• **session**: `AnthropicSession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:663](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L663) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:655](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L655) + +--- + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:662](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L662) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:656](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L656) + +## Accessors + +### metadata + +• `get` **metadata**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :----------------------------------- | +| `contextWindow` | `number` | +| `maxTokens` | `undefined` \| `number` | +| `model` | `"claude-2"` \| `"claude-instant-1"` | +| `temperature` | `number` | +| `tokenizer` | `undefined` | +| `topP` | `number` | + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:691](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L691) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:719](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L719) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:776](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L776) + +--- + +### mapMessagesToPrompt + +▸ **mapMessagesToPrompt**(`messages`): `string` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:702](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L702) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`messages`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:751](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L751) + +--- + +### streamComplete + +▸ `Protected` **streamComplete**(`prompt`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `prompt` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:794](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L794) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:687](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L687) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md new file mode 100644 index 0000000000000000000000000000000000000000..4c3f59628ed8387c7b36c871c9495129dbecacc1 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseDocumentStore.md @@ -0,0 +1,289 @@ +--- +id: "BaseDocumentStore" +title: "Class: BaseDocumentStore" +sidebar_label: "BaseDocumentStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Constructors + +### constructor + +• **new BaseDocumentStore**() + +## Methods + +### addDocuments + +▸ `Abstract` **addDocuments**(`docs`, `allowUpdate`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------- | +| `docs` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | +| `allowUpdate` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L27) + +--- + +### deleteDocument + +▸ `Abstract` **deleteDocument**(`docId`, `raiseError`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----------- | :-------- | +| `docId` | `string` | +| `raiseError` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L34) + +--- + +### deleteRefDoc + +▸ `Abstract` **deleteRefDoc**(`refDocId`, `raiseError`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----------- | :-------- | +| `refDocId` | `string` | +| `raiseError` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L48) + +--- + +### docs + +▸ `Abstract` **docs**(): `Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Returns + +`Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L25) + +--- + +### documentExists + +▸ `Abstract` **documentExists**(`docId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L36) + +--- + +### getAllRefDocInfo + +▸ `Abstract` **getAllRefDocInfo**(): `Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Returns + +`Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L44) + +--- + +### getDocument + +▸ `Abstract` **getDocument**(`docId`, `raiseError`): `Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | +| :----------- | :-------- | +| `docId` | `string` | +| `raiseError` | `boolean` | + +#### Returns + +`Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L29) + +--- + +### getDocumentHash + +▸ `Abstract` **getDocumentHash**(`docId`): `Promise`<`undefined` \| `string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`undefined` \| `string`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L41) + +--- + +### getNode + +▸ **getNode**(`nodeId`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `nodeId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L57) + +--- + +### getNodeDict + +▸ **getNodeDict**(`nodeIdDict`): `Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `nodeIdDict` | `Object` | + +#### Returns + +`Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L65) + +--- + +### getNodes + +▸ **getNodes**(`nodeIds`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------- | :------------ | +| `nodeIds` | `string`[] | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L51) + +--- + +### getRefDocInfo + +▸ `Abstract` **getRefDocInfo**(`refDocId`): `Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L46) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `void` + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------------- | +| `persistPath` | `string` | `defaultPersistPath` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L17) + +--- + +### setDocumentHash + +▸ `Abstract` **setDocumentHash**(`docId`, `docHash`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `docId` | `string` | +| `docHash` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L39) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseEmbedding.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..c3749a4c0d682e0b4de2cb942a8ef3a917ed5a55 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseEmbedding.md @@ -0,0 +1,83 @@ +--- +id: "BaseEmbedding" +title: "Class: BaseEmbedding" +sidebar_label: "BaseEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- **`BaseEmbedding`** + + ↳ [`MultiModalEmbedding`](MultiModalEmbedding.md) + + ↳ [`OpenAIEmbedding`](OpenAIEmbedding.md) + +## Constructors + +### constructor + +• **new BaseEmbedding**() + +## Methods + +### getQueryEmbedding + +▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/types.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L23) + +--- + +### getTextEmbedding + +▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/types.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L22) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseInMemoryKVStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseInMemoryKVStore.md new file mode 100644 index 0000000000000000000000000000000000000000..53e8dae6fd67c93c3f3bbb4db6b227fc5c4ddb4a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseInMemoryKVStore.md @@ -0,0 +1,164 @@ +--- +id: "BaseInMemoryKVStore" +title: "Class: BaseInMemoryKVStore" +sidebar_label: "BaseInMemoryKVStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseKVStore`](BaseKVStore.md) + + ↳ **`BaseInMemoryKVStore`** + +## Constructors + +### constructor + +• **new BaseInMemoryKVStore**() + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[constructor](BaseKVStore.md#constructor) + +## Methods + +### delete + +▸ `Abstract` **delete**(`key`, `collection?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[delete](BaseKVStore.md#delete) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L14) + +--- + +### get + +▸ `Abstract` **get**(`key`, `collection?`): `Promise`<`StoredValue`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`StoredValue`\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[get](BaseKVStore.md#get) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L12) + +--- + +### getAll + +▸ `Abstract` **getAll**(`collection?`): `Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `collection?` | `string` | + +#### Returns + +`Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[getAll](BaseKVStore.md#getall) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L13) + +--- + +### persist + +▸ `Abstract` **persist**(`persistPath`, `fs?`): `void` + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L18) + +--- + +### put + +▸ `Abstract` **put**(`key`, `val`, `collection?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------- | +| `key` | `string` | +| `val` | `Record`<`string`, `any`\> | +| `collection?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseKVStore](BaseKVStore.md).[put](BaseKVStore.md#put) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L7) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`): [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `persistPath` | `string` | + +#### Returns + +[`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L19) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseIndex.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..d3aef6721f2e5ed4825466a0271ce2c6be7d2983 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseIndex.md @@ -0,0 +1,218 @@ +--- +id: "BaseIndex" +title: "Class: BaseIndex<T>" +sidebar_label: "BaseIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +Indexes are the data structure that we store our nodes and embeddings in so +they can be retrieved for our queries. + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Hierarchy + +- **`BaseIndex`** + + ↳ [`KeywordTableIndex`](KeywordTableIndex.md) + + ↳ [`SummaryIndex`](SummaryIndex.md) + + ↳ [`VectorStoreIndex`](VectorStoreIndex.md) + +## Constructors + +### constructor + +• **new BaseIndex**<`T`\>(`init`) + +#### Type parameters + +| Name | +| :--- | +| `T` | + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------ | +| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<`T`\> | + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:161](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L161) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L158) + +--- + +### indexStruct + +• **indexStruct**: `T` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L157) + +## Methods + +### asQueryEngine + +▸ `Abstract` **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:181](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L181) + +--- + +### asRetriever + +▸ `Abstract` **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `options?` | `any` | + +#### Returns + +[`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L174) + +--- + +### deleteRefDoc + +▸ `Abstract` **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------- | +| `refDocId` | `string` | +| `deleteFromDocStore?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L199) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ `Abstract` **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:198](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L198) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseIndexStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseIndexStore.md new file mode 100644 index 0000000000000000000000000000000000000000..acef587b77d03884500671ca0036842a5f7cc4f9 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseIndexStore.md @@ -0,0 +1,108 @@ +--- +id: "BaseIndexStore" +title: "Class: BaseIndexStore" +sidebar_label: "BaseIndexStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Constructors + +### constructor + +• **new BaseIndexStore**() + +## Methods + +### addIndexStruct + +▸ `Abstract` **addIndexStruct**(`indexStruct`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------ | +| `indexStruct` | [`IndexStruct`](IndexStruct.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/types.ts#L13) + +--- + +### deleteIndexStruct + +▸ `Abstract` **deleteIndexStruct**(`key`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `key` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/types.ts#L15) + +--- + +### getIndexStruct + +▸ `Abstract` **getIndexStruct**(`structId?`): `Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `structId?` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/types.ts#L17) + +--- + +### getIndexStructs + +▸ `Abstract` **getIndexStructs**(): `Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Returns + +`Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/types.ts#L11) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------------- | +| `persistPath` | `string` | `defaultPersistPath` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/indexStore/types.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/types.ts#L19) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseKVStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseKVStore.md new file mode 100644 index 0000000000000000000000000000000000000000..6e3bed423b94c90c28026b436e03eff325802326 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseKVStore.md @@ -0,0 +1,105 @@ +--- +id: "BaseKVStore" +title: "Class: BaseKVStore" +sidebar_label: "BaseKVStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- **`BaseKVStore`** + + ↳ [`SimpleKVStore`](SimpleKVStore.md) + + ↳ [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +## Constructors + +### constructor + +• **new BaseKVStore**() + +## Methods + +### delete + +▸ `Abstract` **delete**(`key`, `collection?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L14) + +--- + +### get + +▸ `Abstract` **get**(`key`, `collection?`): `Promise`<`StoredValue`\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `key` | `string` | +| `collection?` | `string` | + +#### Returns + +`Promise`<`StoredValue`\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L12) + +--- + +### getAll + +▸ `Abstract` **getAll**(`collection?`): `Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Parameters + +| Name | Type | +| :------------ | :------- | +| `collection?` | `string` | + +#### Returns + +`Promise`<`Record`<`string`, `StoredValue`\>\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L13) + +--- + +### put + +▸ `Abstract` **put**(`key`, `val`, `collection?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------- | +| `key` | `string` | +| `val` | `Record`<`string`, `any`\> | +| `collection?` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/kvStore/types.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/types.ts#L7) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseNode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e8bbddfec0972d2b870b12b53da58e01944b5da6 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/BaseNode.md @@ -0,0 +1,320 @@ +--- +id: "BaseNode" +title: "Class: BaseNode<T>" +sidebar_label: "BaseNode" +sidebar_position: 0 +custom_edit_url: null +--- + +Generic abstract class for retrievable nodes + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- **`BaseNode`** + + ↳ [`TextNode`](TextNode.md) + +## Constructors + +### constructor + +• **new BaseNode**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------ | +| `init?` | `Partial`<[`BaseNode`](BaseNode.md)<`T`\>\> | + +#### Defined in + +[packages/core/src/Node.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L60) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50) + +--- + +### metadata + +• **metadata**: `T` + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ `Abstract` **generateHash**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L124) + +--- + +### getContent + +▸ `Abstract` **getContent**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L66) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ `Abstract` **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L67) + +--- + +### getType + +▸ `Abstract` **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Defined in + +[packages/core/src/Node.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L64) + +--- + +### setContent + +▸ `Abstract` **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :---- | +| `value` | `any` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/Node.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L68) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CallbackManager.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CallbackManager.md new file mode 100644 index 0000000000000000000000000000000000000000..57a1c0df70071e7ca9d38b8764157fd730e4a623 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CallbackManager.md @@ -0,0 +1,83 @@ +--- +id: "CallbackManager" +title: "Class: CallbackManager" +sidebar_label: "CallbackManager" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- `CallbackManagerMethods` + +## Constructors + +### constructor + +• **new CallbackManager**(`handlers?`) + +#### Parameters + +| Name | Type | +| :---------- | :----------------------- | +| `handlers?` | `CallbackManagerMethods` | + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L86) + +## Properties + +### onLLMStream + +• `Optional` **onLLMStream**: (`params`: [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md)) => `void` \| `Promise`<`void`\> + +#### Type declaration + +▸ (`params`): `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------ | +| `params` | [`StreamCallbackResponse`](../interfaces/StreamCallbackResponse.md) | + +##### Returns + +`void` \| `Promise`<`void`\> + +#### Implementation of + +CallbackManagerMethods.onLLMStream + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:83](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L83) + +--- + +### onRetrieve + +• `Optional` **onRetrieve**: (`params`: [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md)) => `void` \| `Promise`<`void`\> + +#### Type declaration + +▸ (`params`): `void` \| `Promise`<`void`\> + +##### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------------ | +| `params` | [`RetrievalCallbackResponse`](../interfaces/RetrievalCallbackResponse.md) | + +##### Returns + +`void` \| `Promise`<`void`\> + +#### Implementation of + +CallbackManagerMethods.onRetrieve + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L84) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ClipEmbedding.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ClipEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..8fe255b4012df35fa6565b1499efa766215fee4f --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ClipEmbedding.md @@ -0,0 +1,251 @@ +--- +id: "ClipEmbedding" +title: "Class: ClipEmbedding" +sidebar_label: "ClipEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`MultiModalEmbedding`](MultiModalEmbedding.md) + + ↳ **`ClipEmbedding`** + +## Constructors + +### constructor + +• **new ClipEmbedding**() + +#### Inherited from + +[MultiModalEmbedding](MultiModalEmbedding.md).[constructor](MultiModalEmbedding.md#constructor) + +## Properties + +### modelType + +• **modelType**: [`ClipEmbeddingModelType`](../enums/ClipEmbeddingModelType.md) = `ClipEmbeddingModelType.XENOVA_CLIP_VIT_BASE_PATCH16` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L11) + +--- + +### processor + +• `Private` **processor**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L15) + +--- + +### textModel + +• `Private` **textModel**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L17) + +--- + +### tokenizer + +• `Private` **tokenizer**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L14) + +--- + +### visionModel + +• `Private` **visionModel**: `any` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L16) + +## Methods + +### getImageEmbedding + +▸ **getImageEmbedding**(`image`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :--------------------------- | +| `image` | [`ImageType`](../#imagetype) | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[MultiModalEmbedding](MultiModalEmbedding.md).[getImageEmbedding](MultiModalEmbedding.md#getimageembedding) + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L61) + +--- + +### getImageEmbeddings + +▸ **getImageEmbeddings**(`images`): `Promise`<`number`[][]\> + +#### Parameters + +| Name | Type | +| :------- | :----------------------------- | +| `images` | [`ImageType`](../#imagetype)[] | + +#### Returns + +`Promise`<`number`[][]\> + +#### Inherited from + +[MultiModalEmbedding](MultiModalEmbedding.md).[getImageEmbeddings](MultiModalEmbedding.md#getimageembeddings) + +#### Defined in + +[packages/core/src/embeddings/MultiModalEmbedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/MultiModalEmbedding.ts#L11) + +--- + +### getProcessor + +▸ **getProcessor**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L27) + +--- + +### getQueryEmbedding + +▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[MultiModalEmbedding](MultiModalEmbedding.md).[getQueryEmbedding](MultiModalEmbedding.md#getqueryembedding) + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L76) + +--- + +### getTextEmbedding + +▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[MultiModalEmbedding](MultiModalEmbedding.md).[getTextEmbedding](MultiModalEmbedding.md#gettextembedding) + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L68) + +--- + +### getTextModel + +▸ **getTextModel**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L48) + +--- + +### getTokenizer + +▸ **getTokenizer**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L19) + +--- + +### getVisionModel + +▸ **getVisionModel**(): `Promise`<`any`\> + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L35) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Inherited from + +[MultiModalEmbedding](MultiModalEmbedding.md).[similarity](MultiModalEmbedding.md#similarity) + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CompactAndRefine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CompactAndRefine.md new file mode 100644 index 0000000000000000000000000000000000000000..64bae095799991e29b3b755215bd4506c94aaf2a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CompactAndRefine.md @@ -0,0 +1,134 @@ +--- +id: "CompactAndRefine" +title: "Class: CompactAndRefine" +sidebar_label: "CompactAndRefine" +sidebar_position: 0 +custom_edit_url: null +--- + +CompactAndRefine is a slight variation of Refine that first compacts the text chunks into the smallest possible number of chunks. + +## Hierarchy + +- [`Refine`](Refine.md) + + ↳ **`CompactAndRefine`** + +## Constructors + +### constructor + +• **new CompactAndRefine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`) + +#### Parameters + +| Name | Type | +| :---------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `textQATemplate?` | (`__namedParameters`: `Object`) => `string` | +| `refineTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +[Refine](Refine.md).[constructor](Refine.md#constructor) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L82) + +## Properties + +### refineTemplate + +• **refineTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +[Refine](Refine.md).[refineTemplate](Refine.md#refinetemplate) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L80) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[Refine](Refine.md).[serviceContext](Refine.md#servicecontext) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L78) + +--- + +### textQATemplate + +• **textQATemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +[Refine](Refine.md).[textQATemplate](Refine.md#textqatemplate) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:79](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L79) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `prevResponse?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Overrides + +[Refine](Refine.md).[getResponse](Refine.md#getresponse) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:185](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L185) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CondenseQuestionChatEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CondenseQuestionChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..3645ea9f3cb5a82e5a9a1fe3354e63053d9df4ac --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/CondenseQuestionChatEngine.md @@ -0,0 +1,170 @@ +--- +id: "CondenseQuestionChatEngine" +title: "Class: CondenseQuestionChatEngine" +sidebar_label: "CondenseQuestionChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +CondenseQuestionChatEngine is used in conjunction with a Index (for example VectorStoreIndex). +It does two steps on taking a user's chat message: first, it condenses the chat message +with the previous chat history into a question with more context. +Then, it queries the underlying Index using the new question with context and returns +the response. +CondenseQuestionChatEngine performs well when the input is primarily questions about the +underlying data. It performs less well when the chat messages are not questions about the +data, or are very referential to previous context. + +## Implements + +- [`ChatEngine`](../interfaces/ChatEngine.md) + +## Constructors + +### constructor + +• **new CondenseQuestionChatEngine**(`init`) + +#### Parameters + +| Name | Type | +| :---------------------------- | :---------------------------------------------------- | +| `init` | `Object` | +| `init.chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `init.condenseMessagePrompt?` | (`__namedParameters`: `Object`) => `string` | +| `init.queryEngine` | [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) | +| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Defined in + +[packages/core/src/ChatEngine.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L122) + +## Properties + +### chatHistory + +• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L118) + +--- + +### condenseMessagePrompt + +• **condenseMessagePrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ChatEngine.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L120) + +--- + +### queryEngine + +• **queryEngine**: [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L117) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L119) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) + +#### Defined in + +[packages/core/src/ChatEngine.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L147) + +--- + +### condenseQuestion + +▸ `Private` **condenseQuestion**(`chatHistory`, `question`): `Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :---------------------------------------------- | +| `chatHistory` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `question` | `string` | + +#### Returns + +`Promise`<[`ChatResponse`](../interfaces/ChatResponse.md)\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:136](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L136) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset) + +#### Defined in + +[packages/core/src/ChatEngine.ts:169](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L169) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ContextChatEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ContextChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..8b7e1b9e73ab9a2422a5970ab4cb21ce129bed02 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ContextChatEngine.md @@ -0,0 +1,142 @@ +--- +id: "ContextChatEngine" +title: "Class: ContextChatEngine" +sidebar_label: "ContextChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +ContextChatEngine uses the Index to get the appropriate context for each query. +The context is stored in the system prompt, and the chat history is preserved, +ideally allowing the appropriate context to be surfaced for each query. + +## Implements + +- [`ChatEngine`](../interfaces/ChatEngine.md) + +## Constructors + +### constructor + +• **new ContextChatEngine**(`init`) + +#### Parameters + +| Name | Type | +| :-------------------------- | :------------------------------------------------------------------ | +| `init` | `Object` | +| `init.chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `init.chatModel?` | [`LLM`](../interfaces/LLM.md) | +| `init.contextSystemPrompt?` | (`__namedParameters`: `Object`) => `string` | +| `init.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | +| `init.retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | + +#### Defined in + +[packages/core/src/ChatEngine.ts:243](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L243) + +## Properties + +### chatHistory + +• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L240) + +--- + +### chatModel + +• **chatModel**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:239](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L239) + +--- + +### contextGenerator + +• **contextGenerator**: [`ContextGenerator`](../interfaces/ContextGenerator.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:241](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L241) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) + +#### Defined in + +[packages/core/src/ChatEngine.ts:259](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L259) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset) + +#### Defined in + +[packages/core/src/ChatEngine.ts:336](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L336) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`message`, `chatHistory?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L300) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/DefaultContextGenerator.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/DefaultContextGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..edba30d0ba8d2023ad97e97147533755f8e53f58 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/DefaultContextGenerator.md @@ -0,0 +1,119 @@ +--- +id: "DefaultContextGenerator" +title: "Class: DefaultContextGenerator" +sidebar_label: "DefaultContextGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`ContextGenerator`](../interfaces/ContextGenerator.md) + +## Constructors + +### constructor + +• **new DefaultContextGenerator**(`init`) + +#### Parameters + +| Name | Type | +| :-------------------------- | :------------------------------------------------------------------ | +| `init` | `Object` | +| `init.contextSystemPrompt?` | (`__namedParameters`: `Object`) => `string` | +| `init.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | +| `init.retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | + +#### Defined in + +[packages/core/src/ChatEngine.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L188) + +## Properties + +### contextSystemPrompt + +• **contextSystemPrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ChatEngine.ts:185](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L185) + +--- + +### nodePostprocessors + +• **nodePostprocessors**: [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:186](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L186) + +--- + +### retriever + +• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:184](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L184) + +## Methods + +### applyNodePostprocessors + +▸ `Private` **applyNodePostprocessors**(`nodes`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L199) + +--- + +### generate + +▸ **generate**(`message`, `parentEvent?`): `Promise`<[`Context`](../interfaces/Context.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `message` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`Context`](../interfaces/Context.md)\> + +#### Implementation of + +[ContextGenerator](../interfaces/ContextGenerator.md).[generate](../interfaces/ContextGenerator.md#generate) + +#### Defined in + +[packages/core/src/ChatEngine.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L206) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Document.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Document.md new file mode 100644 index 0000000000000000000000000000000000000000..7893b1d67286ee861efb92be587a304d869b1e29 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Document.md @@ -0,0 +1,504 @@ +--- +id: "Document" +title: "Class: Document<T>" +sidebar_label: "Document" +sidebar_position: 0 +custom_edit_url: null +--- + +A document is just a special text node with a docId. + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`TextNode`](TextNode.md)<`T`\> + + ↳ **`Document`** + +## Constructors + +### constructor + +• **new Document**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------ | +| `init?` | `Partial`<[`Document`](Document.md)<`T`\>\> | + +#### Overrides + +[TextNode](TextNode.md).[constructor](TextNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:254](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L254) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[TextNode](TextNode.md).[embedding](TextNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[hash](TextNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[TextNode](TextNode.md).[id\_](TextNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[TextNode](TextNode.md).[metadata](TextNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[TextNode](TextNode.md).[relationships](TextNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[text](TextNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +TextNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getContent](TextNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getText](TextNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[TextNode](TextNode.md).[getType](TextNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:263](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L263) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[TextNode](TextNode.md).[setContent](TextNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[TextNode](TextNode.md).[toJSON](TextNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/HTMLReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/HTMLReader.md new file mode 100644 index 0000000000000000000000000000000000000000..5406248563fc5e7f692bed558f5f39f4a6dca5d7 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/HTMLReader.md @@ -0,0 +1,109 @@ +--- +id: "HTMLReader" +title: "Class: HTMLReader" +sidebar_label: "HTMLReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Extract the significant text from an arbitrary HTML document. +The contents of any head, script, style, and xml tags are removed completely. +The URLs for a[href] tags are extracted, along with the inner text of the tag. +All other tags are removed, and the inner text is kept intact. +Html entities (e.g., &) are not decoded. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new HTMLReader**() + +## Methods + +### getOptions + +▸ **getOptions**(): `Object` + +Wrapper for our configuration options passed to string-strip-html library + +#### Returns + +`Object` + +An object of options for the underlying library + +| Name | Type | +| :------------------------------- | :--------- | +| `skipHtmlDecoding` | `boolean` | +| `stripTogetherWithTheirContents` | `string`[] | + +**`See`** + +https://codsen.com/os/string-strip-html/examples + +#### Defined in + +[packages/core/src/readers/HTMLReader.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/HTMLReader.ts#L48) + +--- + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Public method for this reader. +Required by BaseReader interface. + +#### Parameters + +| Name | Type | Default value | Description | +| :----- | :-------------------------------------------------------- | :------------ | :------------------------------------------------- | +| `file` | `string` | `undefined` | Path/name of the file to be loaded. | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | fs wrapper interface for getting the file content. | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Promise<Document[]> A Promise object, eventually yielding zero or one Document parsed from the HTML content of the specified file. + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/HTMLReader.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/HTMLReader.ts#L21) + +--- + +### parseContent + +▸ **parseContent**(`html`, `options?`): `Promise`<`string`\> + +Wrapper for string-strip-html usage. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------- | :---------------------------------------------- | +| `html` | `string` | Raw HTML content to be parsed. | +| `options` | `any` | An object of options for the underlying library | + +#### Returns + +`Promise`<`string`\> + +The HTML content, stripped of unwanted tags and attributes + +**`See`** + +getOptions + +#### Defined in + +[packages/core/src/readers/HTMLReader.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/HTMLReader.ts#L38) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/HistoryChatEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/HistoryChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..894e858e8d195e3a8ea0e7e35659b8f9e1d69241 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/HistoryChatEngine.md @@ -0,0 +1,120 @@ +--- +id: "HistoryChatEngine" +title: "Class: HistoryChatEngine" +sidebar_label: "HistoryChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +HistoryChatEngine is a ChatEngine that uses a `ChatHistory` object +to keeps track of chat's message history. +A `ChatHistory` object is passed as a parameter for each call to the `chat` method, +so the state of the chat engine is preserved between calls. +Optionally, a `ContextGenerator` can be used to generate an additional context for each call to `chat`. + +## Constructors + +### constructor + +• **new HistoryChatEngine**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------ | +| `init?` | `Partial`<[`HistoryChatEngine`](HistoryChatEngine.md)\> | + +#### Defined in + +[packages/core/src/ChatEngine.ts:381](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L381) + +## Properties + +### contextGenerator + +• `Optional` **contextGenerator**: [`ContextGenerator`](../interfaces/ContextGenerator.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:379](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L379) + +--- + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:378](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L378) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory`, `streaming?`): `Promise`<`R`\> + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory` | [`ChatHistory`](../interfaces/ChatHistory.md) | +| `streaming?` | `T` | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:386](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L386) + +--- + +### prepareRequestMessages + +▸ `Private` **prepareRequestMessages**(`message`, `chatHistory`): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory` | [`ChatHistory`](../interfaces/ChatHistory.md) | + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:433](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L433) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`message`, `chatHistory`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory` | [`ChatHistory`](../interfaces/ChatHistory.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:407](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L407) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ImageDocument.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ImageDocument.md new file mode 100644 index 0000000000000000000000000000000000000000..fa8f7ad7cec50d5132317383957e4fc915e9bf9e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ImageDocument.md @@ -0,0 +1,518 @@ +--- +id: "ImageDocument" +title: "Class: ImageDocument<T>" +sidebar_label: "ImageDocument" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`ImageNode`](ImageNode.md)<`T`\> + + ↳ **`ImageDocument`** + +## Constructors + +### constructor + +• **new ImageDocument**<`T`\>(`init`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------------------- | +| `init` | [`ImageNodeConstructorProps`](../#imagenodeconstructorprops)<`T`\> | + +#### Overrides + +[ImageNode](ImageNode.md).[constructor](ImageNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:310](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L310) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[ImageNode](ImageNode.md).[embedding](ImageNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[ImageNode](ImageNode.md).[endCharIdx](ImageNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[ImageNode](ImageNode.md).[excludedEmbedMetadataKeys](ImageNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[ImageNode](ImageNode.md).[excludedLlmMetadataKeys](ImageNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[ImageNode](ImageNode.md).[hash](ImageNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[ImageNode](ImageNode.md).[id\_](ImageNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50) + +--- + +### image + +• **image**: [`ImageType`](../#imagetype) + +#### Inherited from + +[ImageNode](ImageNode.md).[image](ImageNode.md#image) + +#### Defined in + +[packages/core/src/Node.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L297) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[ImageNode](ImageNode.md).[metadata](ImageNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[ImageNode](ImageNode.md).[metadataSeparator](ImageNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[ImageNode](ImageNode.md).[relationships](ImageNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[ImageNode](ImageNode.md).[startCharIdx](ImageNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[ImageNode](ImageNode.md).[text](ImageNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +ImageNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +ImageNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[ImageNode](ImageNode.md).[asRelatedNodeInfo](ImageNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[generateHash](ImageNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[getContent](ImageNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[ImageNode](ImageNode.md).[getEmbedding](ImageNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[getMetadataStr](ImageNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[ImageNode](ImageNode.md).[getNodeInfo](ImageNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[ImageNode](ImageNode.md).[getText](ImageNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[ImageNode](ImageNode.md).[getType](ImageNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:318](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L318) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[ImageNode](ImageNode.md).[setContent](ImageNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[ImageNode](ImageNode.md).[toJSON](ImageNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ImageNode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ImageNode.md new file mode 100644 index 0000000000000000000000000000000000000000..2c79bd4a3506bd224b6218d100b77e0c3ac748b4 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ImageNode.md @@ -0,0 +1,516 @@ +--- +id: "ImageNode" +title: "Class: ImageNode<T>" +sidebar_label: "ImageNode" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`TextNode`](TextNode.md)<`T`\> + + ↳ **`ImageNode`** + + ↳↳ [`ImageDocument`](ImageDocument.md) + +## Constructors + +### constructor + +• **new ImageNode**<`T`\>(`init`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------------------- | +| `init` | [`ImageNodeConstructorProps`](../#imagenodeconstructorprops)<`T`\> | + +#### Overrides + +[TextNode](TextNode.md).[constructor](TextNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:299](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L299) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[TextNode](TextNode.md).[embedding](TextNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[hash](TextNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[TextNode](TextNode.md).[id\_](TextNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50) + +--- + +### image + +• **image**: [`ImageType`](../#imagetype) + +#### Defined in + +[packages/core/src/Node.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L297) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[TextNode](TextNode.md).[metadata](TextNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[TextNode](TextNode.md).[relationships](TextNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[text](TextNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +TextNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getContent](TextNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getText](TextNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[TextNode](TextNode.md).[getType](TextNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:304](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L304) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[TextNode](TextNode.md).[setContent](TextNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[TextNode](TextNode.md).[toJSON](TextNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/InMemoryFileSystem.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/InMemoryFileSystem.md new file mode 100644 index 0000000000000000000000000000000000000000..b058cfa4f15757483606ff03279ae46729d46d46 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/InMemoryFileSystem.md @@ -0,0 +1,129 @@ +--- +id: "InMemoryFileSystem" +title: "Class: InMemoryFileSystem" +sidebar_label: "InMemoryFileSystem" +sidebar_position: 0 +custom_edit_url: null +--- + +A filesystem implementation that stores files in memory. + +## Implements + +- [`GenericFileSystem`](../interfaces/GenericFileSystem.md) + +## Constructors + +### constructor + +• **new InMemoryFileSystem**() + +## Properties + +### files + +• `Private` **files**: `Record`<`string`, `any`\> = `{}` + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L25) + +## Methods + +### access + +▸ **access**(`path`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[access](../interfaces/GenericFileSystem.md#access) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L38) + +--- + +### mkdir + +▸ **mkdir**(`path`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[mkdir](../interfaces/GenericFileSystem.md#mkdir) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L44) + +--- + +### readFile + +▸ **readFile**(`path`, `options?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[readFile](../interfaces/GenericFileSystem.md#readfile) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L31) + +--- + +### writeFile + +▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `content` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[GenericFileSystem](../interfaces/GenericFileSystem.md).[writeFile](../interfaces/GenericFileSystem.md#writefile) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L27) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexDict.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexDict.md new file mode 100644 index 0000000000000000000000000000000000000000..ac0dc59823a3795b625e8115c141a2d0b84ec61c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexDict.md @@ -0,0 +1,161 @@ +--- +id: "IndexDict" +title: "Class: IndexDict" +sidebar_label: "IndexDict" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- [`IndexStruct`](IndexStruct.md) + + ↳ **`IndexDict`** + +## Constructors + +### constructor + +• **new IndexDict**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Inherited from + +[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### nodesDict + +• **nodesDict**: `Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> = `{}` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L46) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L17) + +--- + +### type + +• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.SIMPLE_DICT` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L47) + +## Methods + +### addNode + +▸ **addNode**(`node`, `textId?`): `void` + +#### Parameters + +| Name | Type | +| :-------- | :----------------------------------------------------- | +| `node` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\> | +| `textId?` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L56) + +--- + +### delete + +▸ **delete**(`nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L69) + +--- + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Overrides + +[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L49) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L61) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexList.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexList.md new file mode 100644 index 0000000000000000000000000000000000000000..ba91bd2d05abf5a3ffc18b5e73e0f2d352c59075 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexList.md @@ -0,0 +1,140 @@ +--- +id: "IndexList" +title: "Class: IndexList" +sidebar_label: "IndexList" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- [`IndexStruct`](IndexStruct.md) + + ↳ **`IndexList`** + +## Constructors + +### constructor + +• **new IndexList**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Inherited from + +[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### nodes + +• **nodes**: `string`[] = `[]` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L94) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L17) + +--- + +### type + +• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.LIST` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:95](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L95) + +## Methods + +### addNode + +▸ **addNode**(`node`): `void` + +#### Parameters + +| Name | Type | +| :----- | :----------------------------------------------------- | +| `node` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:97](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L97) + +--- + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L31) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L101) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexNode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexNode.md new file mode 100644 index 0000000000000000000000000000000000000000..73b1ad4a83f9ed058dbd003caa0d8dc7baf61644 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexNode.md @@ -0,0 +1,514 @@ +--- +id: "IndexNode" +title: "Class: IndexNode<T>" +sidebar_label: "IndexNode" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`TextNode`](TextNode.md)<`T`\> + + ↳ **`IndexNode`** + +## Constructors + +### constructor + +• **new IndexNode**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------- | +| `init?` | `Partial`<[`IndexNode`](IndexNode.md)<`T`\>\> | + +#### Overrides + +[TextNode](TextNode.md).[constructor](TextNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:236](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L236) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[TextNode](TextNode.md).[embedding](TextNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[endCharIdx](TextNode.md#endcharidx) + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedEmbedMetadataKeys](TextNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[TextNode](TextNode.md).[excludedLlmMetadataKeys](TextNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[hash](TextNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[TextNode](TextNode.md).[id\_](TextNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50) + +--- + +### indexId + +• **indexId**: `string` = `""` + +#### Defined in + +[packages/core/src/Node.ts:234](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L234) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[TextNode](TextNode.md).[metadata](TextNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Inherited from + +[TextNode](TextNode.md).[metadataSeparator](TextNode.md#metadataseparator) + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[TextNode](TextNode.md).[relationships](TextNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Inherited from + +[TextNode](TextNode.md).[startCharIdx](TextNode.md#startcharidx) + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Inherited from + +[TextNode](TextNode.md).[text](TextNode.md#text) + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +TextNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +TextNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[TextNode](TextNode.md).[asRelatedNodeInfo](TextNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[generateHash](TextNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getContent](TextNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[TextNode](TextNode.md).[getEmbedding](TextNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getMetadataStr](TextNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Inherited from + +[TextNode](TextNode.md).[getNodeInfo](TextNode.md#getnodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[TextNode](TextNode.md).[getText](TextNode.md#gettext) + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[TextNode](TextNode.md).[getType](TextNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:245](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L245) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Inherited from + +[TextNode](TextNode.md).[setContent](TextNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[TextNode](TextNode.md).[toJSON](TextNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexStruct.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexStruct.md new file mode 100644 index 0000000000000000000000000000000000000000..0f6fa57186c5bcaa564ada4682837ed1fc78950c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/IndexStruct.md @@ -0,0 +1,84 @@ +--- +id: "IndexStruct" +title: "Class: IndexStruct" +sidebar_label: "IndexStruct" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- **`IndexStruct`** + + ↳ [`IndexDict`](IndexDict.md) + + ↳ [`IndexList`](IndexList.md) + + ↳ [`KeywordTable`](KeywordTable.md) + +## Constructors + +### constructor + +• **new IndexStruct**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L17) + +## Methods + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L31) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L24) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTable.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTable.md new file mode 100644 index 0000000000000000000000000000000000000000..d5b95d711755a55e8b94248ac27869c25fe7e89a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTable.md @@ -0,0 +1,162 @@ +--- +id: "KeywordTable" +title: "Class: KeywordTable" +sidebar_label: "KeywordTable" +sidebar_position: 0 +custom_edit_url: null +--- + +The underlying structure of each index. + +## Hierarchy + +- [`IndexStruct`](IndexStruct.md) + + ↳ **`KeywordTable`** + +## Constructors + +### constructor + +• **new KeywordTable**(`indexId?`, `summary?`) + +#### Parameters + +| Name | Type | Default value | +| :-------- | :---------- | :------------ | +| `indexId` | `string` | `undefined` | +| `summary` | `undefined` | `undefined` | + +#### Inherited from + +[IndexStruct](IndexStruct.md).[constructor](IndexStruct.md#constructor) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L19) + +## Properties + +### indexId + +• **indexId**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[indexId](IndexStruct.md#indexid) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L16) + +--- + +### summary + +• `Optional` **summary**: `string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[summary](IndexStruct.md#summary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L17) + +--- + +### table + +• **table**: `Map`<`string`, `Set`<`string`\>\> + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L112) + +--- + +### type + +• **type**: [`IndexStructType`](../enums/IndexStructType.md) = `IndexStructType.KEYWORD_TABLE` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:113](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L113) + +## Methods + +### addNode + +▸ **addNode**(`keywords`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `keywords` | `string`[] | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L114) + +--- + +### deleteNode + +▸ **deleteNode**(`keywords`, `nodeId`): `void` + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `keywords` | `string`[] | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L123) + +--- + +### getSummary + +▸ **getSummary**(): `string` + +#### Returns + +`string` + +#### Inherited from + +[IndexStruct](IndexStruct.md).[getSummary](IndexStruct.md#getsummary) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L31) + +--- + +### toJson + +▸ **toJson**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Overrides + +[IndexStruct](IndexStruct.md).[toJson](IndexStruct.md#tojson) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L131) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableIndex.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..6c5e381df3bf35496ff9159b2501bb443b70a170 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableIndex.md @@ -0,0 +1,382 @@ +--- +id: "KeywordTableIndex" +title: "Class: KeywordTableIndex" +sidebar_label: "KeywordTableIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +The KeywordTableIndex, an index that extracts keywords from each Node and builds a mapping from each keyword to the corresponding Nodes of that keyword. + +## Hierarchy + +- [`BaseIndex`](BaseIndex.md)<[`KeywordTable`](KeywordTable.md)\> + + ↳ **`KeywordTableIndex`** + +## Constructors + +### constructor + +• **new KeywordTableIndex**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------------ | +| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<[`KeywordTable`](KeywordTable.md)\> | + +#### Overrides + +[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L49) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L158) + +--- + +### indexStruct + +• **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L157) + +## Methods + +### asQueryEngine + +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | - | +| `options.preFilters?` | `unknown` | - | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L130) + +--- + +### asRetriever + +▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `options?` | `any` | + +#### Returns + +[`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L119) + +--- + +### deleteNode + +▸ **deleteNode**(`nodeId`): `void` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `nodeId` | `string` | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L224) + +--- + +### deleteNodes + +▸ **deleteNodes**(`nodeIds`, `deleteFromDocStore`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------- | :--------- | +| `nodeIds` | `string`[] | +| `deleteFromDocStore` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:242](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L242) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------- | +| `refDocId` | `string` | +| `deleteFromDocStore?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:256](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L256) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes) + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L214) + +--- + +### buildIndexFromNodes + +▸ `Static` **buildIndexFromNodes**(`nodes`, `docStore`, `serviceContext`): `Promise`<[`KeywordTable`](KeywordTable.md)\> + +Get keywords for nodes and place them into the index. + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | +| `docStore` | [`BaseDocumentStore`](BaseDocumentStore.md) | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +`Promise`<[`KeywordTable`](KeywordTable.md)\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L197) + +--- + +### extractKeywords + +▸ `Static` **extractKeywords**(`text`, `serviceContext`): `Promise`<`Set`<`string`\>\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------------------- | +| `text` | `string` | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +`Promise`<`Set`<`string`\>\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L145) + +--- + +### fromDocuments + +▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +High level API: split documents, get keywords, and build index. + +#### Parameters + +| Name | Type | +| :--------------------- | :------------------------------------------------------- | +| `documents` | [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] | +| `args` | `Object` | +| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | + +#### Returns + +`Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:164](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L164) + +--- + +### init + +▸ `Static` **init**(`options`): `Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :-------------------- | +| `options` | `KeywordIndexOptions` | + +#### Returns + +`Promise`<[`KeywordTableIndex`](KeywordTableIndex.md)\> + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L53) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableLLMRetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableLLMRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..2cf8c807b77199858f687a96f51ef34bd534f020 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableLLMRetriever.md @@ -0,0 +1,244 @@ +--- +id: "KeywordTableLLMRetriever" +title: "Class: KeywordTableLLMRetriever" +sidebar_label: "KeywordTableLLMRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseKeywordTableRetriever` + + ↳ **`KeywordTableLLMRetriever`** + +## Constructors + +### constructor + +• **new KeywordTableLLMRetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :------------------------------------------ | +| `«destructured»` | `Object` | +| › `index` | [`KeywordTableIndex`](KeywordTableIndex.md) | +| › `keywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | +| › `maxKeywordsPerQuery` | `number` | +| › `numChunksPerQuery` | `number` | +| › `queryKeywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +BaseKeywordTableRetriever.constructor + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L31) + +## Properties + +### docstore + +• `Protected` **docstore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +BaseKeywordTableRetriever.docstore + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L23) + +--- + +### index + +• `Protected` **index**: [`KeywordTableIndex`](KeywordTableIndex.md) + +#### Inherited from + +BaseKeywordTableRetriever.index + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L21) + +--- + +### indexStruct + +• `Protected` **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +BaseKeywordTableRetriever.indexStruct + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L22) + +--- + +### keywordExtractTemplate + +• `Protected` **keywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.keywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L28) + +--- + +### maxKeywordsPerQuery + +• `Protected` **maxKeywordsPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.maxKeywordsPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L26) + +--- + +### numChunksPerQuery + +• `Protected` **numChunksPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.numChunksPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L27) + +--- + +### queryKeywordExtractTemplate + +• `Protected` **queryKeywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.queryKeywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L29) + +--- + +### serviceContext + +• `Protected` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.serviceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L24) + +## Methods + +### getKeywords + +▸ **getKeywords**(`query`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Overrides + +BaseKeywordTableRetriever.getKeywords + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L88) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.getServiceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L81) + +--- + +### retrieve + +▸ **retrieve**(`query`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +BaseKeywordTableRetriever.retrieve + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableRAKERetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableRAKERetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..10714650f5345390306fc0c2145b9cd1bdb8cf10 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableRAKERetriever.md @@ -0,0 +1,244 @@ +--- +id: "KeywordTableRAKERetriever" +title: "Class: KeywordTableRAKERetriever" +sidebar_label: "KeywordTableRAKERetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseKeywordTableRetriever` + + ↳ **`KeywordTableRAKERetriever`** + +## Constructors + +### constructor + +• **new KeywordTableRAKERetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :------------------------------------------ | +| `«destructured»` | `Object` | +| › `index` | [`KeywordTableIndex`](KeywordTableIndex.md) | +| › `keywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | +| › `maxKeywordsPerQuery` | `number` | +| › `numChunksPerQuery` | `number` | +| › `queryKeywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +BaseKeywordTableRetriever.constructor + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L31) + +## Properties + +### docstore + +• `Protected` **docstore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +BaseKeywordTableRetriever.docstore + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L23) + +--- + +### index + +• `Protected` **index**: [`KeywordTableIndex`](KeywordTableIndex.md) + +#### Inherited from + +BaseKeywordTableRetriever.index + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L21) + +--- + +### indexStruct + +• `Protected` **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +BaseKeywordTableRetriever.indexStruct + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L22) + +--- + +### keywordExtractTemplate + +• `Protected` **keywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.keywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L28) + +--- + +### maxKeywordsPerQuery + +• `Protected` **maxKeywordsPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.maxKeywordsPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L26) + +--- + +### numChunksPerQuery + +• `Protected` **numChunksPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.numChunksPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L27) + +--- + +### queryKeywordExtractTemplate + +• `Protected` **queryKeywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.queryKeywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L29) + +--- + +### serviceContext + +• `Protected` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.serviceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L24) + +## Methods + +### getKeywords + +▸ **getKeywords**(`query`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Overrides + +BaseKeywordTableRetriever.getKeywords + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:114](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L114) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.getServiceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L81) + +--- + +### retrieve + +▸ **retrieve**(`query`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +BaseKeywordTableRetriever.retrieve + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableSimpleRetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableSimpleRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..70ccdfd82ebde6b6591a3dfb6d3fe9efd80a5644 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/KeywordTableSimpleRetriever.md @@ -0,0 +1,244 @@ +--- +id: "KeywordTableSimpleRetriever" +title: "Class: KeywordTableSimpleRetriever" +sidebar_label: "KeywordTableSimpleRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseKeywordTableRetriever` + + ↳ **`KeywordTableSimpleRetriever`** + +## Constructors + +### constructor + +• **new KeywordTableSimpleRetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------------------- | :------------------------------------------ | +| `«destructured»` | `Object` | +| › `index` | [`KeywordTableIndex`](KeywordTableIndex.md) | +| › `keywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | +| › `maxKeywordsPerQuery` | `number` | +| › `numChunksPerQuery` | `number` | +| › `queryKeywordExtractTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Inherited from + +BaseKeywordTableRetriever.constructor + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L31) + +## Properties + +### docstore + +• `Protected` **docstore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +BaseKeywordTableRetriever.docstore + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L23) + +--- + +### index + +• `Protected` **index**: [`KeywordTableIndex`](KeywordTableIndex.md) + +#### Inherited from + +BaseKeywordTableRetriever.index + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L21) + +--- + +### indexStruct + +• `Protected` **indexStruct**: [`KeywordTable`](KeywordTable.md) + +#### Inherited from + +BaseKeywordTableRetriever.indexStruct + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L22) + +--- + +### keywordExtractTemplate + +• `Protected` **keywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.keywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L28) + +--- + +### maxKeywordsPerQuery + +• `Protected` **maxKeywordsPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.maxKeywordsPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L26) + +--- + +### numChunksPerQuery + +• `Protected` **numChunksPerQuery**: `number` + +#### Inherited from + +BaseKeywordTableRetriever.numChunksPerQuery + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L27) + +--- + +### queryKeywordExtractTemplate + +• `Protected` **queryKeywordExtractTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Inherited from + +BaseKeywordTableRetriever.queryKeywordExtractTemplate + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L29) + +--- + +### serviceContext + +• `Protected` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.serviceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L24) + +## Methods + +### getKeywords + +▸ **getKeywords**(`query`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Overrides + +BaseKeywordTableRetriever.getKeywords + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L105) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +BaseKeywordTableRetriever.getServiceContext + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L81) + +--- + +### retrieve + +▸ **retrieve**(`query`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +BaseKeywordTableRetriever.retrieve + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/LLMQuestionGenerator.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/LLMQuestionGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..3a18f42f30e45e973fbd1aac04d199ef46d2dd1f --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/LLMQuestionGenerator.md @@ -0,0 +1,98 @@ +--- +id: "LLMQuestionGenerator" +title: "Class: LLMQuestionGenerator" +sidebar_label: "LLMQuestionGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +LLMQuestionGenerator uses the LLM to generate new questions for the LLM using tools and a user query. + +## Implements + +- [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) + +## Constructors + +### constructor + +• **new LLMQuestionGenerator**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------ | +| `init?` | `Partial`<[`LLMQuestionGenerator`](LLMQuestionGenerator.md)\> | + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L34) + +## Properties + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L30) + +--- + +### outputParser + +• **outputParser**: [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\> + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L32) + +--- + +### prompt + +• **prompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L31) + +## Methods + +### generate + +▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------ | +| `tools` | [`ToolMetadata`](../interfaces/ToolMetadata.md)[] | +| `query` | `string` | + +#### Returns + +`Promise`<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Implementation of + +[BaseQuestionGenerator](../interfaces/BaseQuestionGenerator.md).[generate](../interfaces/BaseQuestionGenerator.md#generate) + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L40) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/LlamaDeuce.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/LlamaDeuce.md new file mode 100644 index 0000000000000000000000000000000000000000..7281a4a5f6cb1ccce3bc555d2900383d92648010 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/LlamaDeuce.md @@ -0,0 +1,325 @@ +--- +id: "LlamaDeuce" +title: "Class: LlamaDeuce" +sidebar_label: "LlamaDeuce" +sidebar_position: 0 +custom_edit_url: null +--- + +Llama2 LLM implementation + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new LlamaDeuce**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------- | +| `init?` | `Partial`<[`LlamaDeuce`](LlamaDeuce.md)\> | + +#### Defined in + +[packages/core/src/llm/LLM.ts:434](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L434) + +## Properties + +### chatStrategy + +• **chatStrategy**: [`DeuceChatStrategy`](../enums/DeuceChatStrategy.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:427](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L427) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:432](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L432) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:430](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L430) + +--- + +### model + +• **model**: `"Llama-2-70b-chat-old"` \| `"Llama-2-70b-chat-4bit"` \| `"Llama-2-13b-chat-old"` \| `"Llama-2-13b-chat-4bit"` \| `"Llama-2-7b-chat-old"` \| `"Llama-2-7b-chat-4bit"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:426](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L426) + +--- + +### replicateSession + +• **replicateSession**: `ReplicateSession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:431](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L431) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:428](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L428) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:429](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L429) + +## Accessors + +### metadata + +• `get` **metadata**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contextWindow` | `number` | +| `maxTokens` | `undefined` \| `number` | +| `model` | `"Llama-2-70b-chat-old"` \| `"Llama-2-70b-chat-4bit"` \| `"Llama-2-13b-chat-old"` \| `"Llama-2-13b-chat-4bit"` \| `"Llama-2-7b-chat-old"` \| `"Llama-2-7b-chat-4bit"` | +| `temperature` | `number` | +| `tokenizer` | `undefined` | +| `topP` | `number` | + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:454](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L454) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `_parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :-------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `_parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:592](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L592) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:632](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L632) + +--- + +### mapMessageTypeA16Z + +▸ **mapMessageTypeA16Z**(`messageType`): `string` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------- | +| `messageType` | [`MessageType`](../#messagetype) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:501](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L501) + +--- + +### mapMessagesToPrompt + +▸ **mapMessagesToPrompt**(`messages`): `Object` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Object` + +| Name | Type | +| :------------- | :------- | +| `prompt` | `string` | +| `systemPrompt` | `any` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:465](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L465) + +--- + +### mapMessagesToPromptA16Z + +▸ **mapMessagesToPromptA16Z**(`messages`): `Object` + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Object` + +| Name | Type | +| :------------- | :---------- | +| `prompt` | `string` | +| `systemPrompt` | `undefined` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:487](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L487) + +--- + +### mapMessagesToPromptMeta + +▸ **mapMessagesToPromptMeta**(`messages`, `opts?`): `Object` + +#### Parameters + +| Name | Type | +| :-------------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `opts?` | `Object` | +| `opts.replicate4Bit?` | `boolean` | +| `opts.withBos?` | `boolean` | +| `opts.withNewlines?` | `boolean` | + +#### Returns + +`Object` + +| Name | Type | +| :------------- | :------- | +| `prompt` | `string` | +| `systemPrompt` | `any` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:514](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L514) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:450](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L450) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MarkdownReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MarkdownReader.md new file mode 100644 index 0000000000000000000000000000000000000000..748bbc2c9eacb4c0988ae42218b3f6b232ce43a7 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MarkdownReader.md @@ -0,0 +1,161 @@ +--- +id: "MarkdownReader" +title: "Class: MarkdownReader" +sidebar_label: "MarkdownReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Extract text from markdown files. +Returns dictionary with keys as headers and values as the text between headers. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new MarkdownReader**(`removeHyperlinks?`, `removeImages?`) + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------ | :-------- | :------------ | :---------------------------------------------- | +| `removeHyperlinks?` | `boolean` | `true` | Indicates whether hyperlinks should be removed. | +| `removeImages?` | `boolean` | `true` | Indicates whether images should be removed. | + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L19) + +## Properties + +### \_removeHyperlinks + +• `Private` **\_removeHyperlinks**: `boolean` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L12) + +--- + +### \_removeImages + +• `Private` **\_removeImages**: `boolean` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L13) + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----- | :-------------------------------------------------------- | :------------ | +| `file` | `string` | `undefined` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L90) + +--- + +### markdownToTups + +▸ **markdownToTups**(`markdownText`): `MarkdownTuple`[] + +Convert a markdown file to a dictionary. +The keys are the headers and the values are the text under each header. + +#### Parameters + +| Name | Type | Description | +| :------------- | :------- | :---------------------------- | +| `markdownText` | `string` | The markdown text to convert. | + +#### Returns + +`MarkdownTuple`[] + +- An array of tuples, where each tuple contains a header (or null) and its corresponding text. + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L30) + +--- + +### parseTups + +▸ **parseTups**(`content`): `MarkdownTuple`[] + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`MarkdownTuple`[] + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:79](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L79) + +--- + +### removeHyperlinks + +▸ **removeHyperlinks**(`content`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L74) + +--- + +### removeImages + +▸ **removeImages**(`content`): `string` + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `content` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/readers/MarkdownReader.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/MarkdownReader.ts#L69) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MongoDBAtlasVectorSearch.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MongoDBAtlasVectorSearch.md new file mode 100644 index 0000000000000000000000000000000000000000..114e33d61695f820c239ba16d46ebfbfd4183698 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MongoDBAtlasVectorSearch.md @@ -0,0 +1,223 @@ +--- +id: "MongoDBAtlasVectorSearch" +title: "Class: MongoDBAtlasVectorSearch" +sidebar_label: "MongoDBAtlasVectorSearch" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`VectorStore`](../interfaces/VectorStore.md) + +## Constructors + +### constructor + +• **new MongoDBAtlasVectorSearch**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :-------------------------------------------------------------------------------------------------------------------------- | +| `init` | `Partial`<[`MongoDBAtlasVectorSearch`](MongoDBAtlasVectorSearch.md)\> & { `collectionName`: `string` ; `dbName`: `string` } | + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L36) + +## Properties + +### collection + +• `Private` **collection**: `Collection`<`Document`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L34) + +--- + +### embeddingKey + +• **embeddingKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L29) + +--- + +### flatMetadata + +• **flatMetadata**: `boolean` = `true` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L25) + +--- + +### idKey + +• **idKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L30) + +--- + +### indexName + +• **indexName**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L28) + +--- + +### insertOptions + +• `Optional` **insertOptions**: `BulkWriteOptions` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L33) + +--- + +### metadataKey + +• **metadataKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L32) + +--- + +### mongodbClient + +• **mongodbClient**: `MongoClient` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L27) + +--- + +### storesText + +• **storesText**: `boolean` = `true` + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[storesText](../interfaces/VectorStore.md#storestext) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L24) + +--- + +### textKey + +• **textKey**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L31) + +## Accessors + +### client + +• `get` **client**(): `any` + +#### Returns + +`any` + +#### Implementation of + +VectorStore.client + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L103) + +## Methods + +### add + +▸ **add**(`nodes`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`string`[]\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[add](../interfaces/VectorStore.md#add) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L65) + +--- + +### delete + +▸ **delete**(`refDocId`, `deleteOptions?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `refDocId` | `string` | +| `deleteOptions?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[delete](../interfaces/VectorStore.md#delete) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:94](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L94) + +--- + +### query + +▸ **query**(`query`, `options?`): `Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------ | +| `query` | [`VectorStoreQuery`](../interfaces/VectorStoreQuery.md) | +| `options?` | `any` | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[query](../interfaces/VectorStore.md#query) + +#### Defined in + +[packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts:107](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/MongoDBAtlasVectorStore.ts#L107) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MultiModalEmbedding.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MultiModalEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..44a5d5b44733c1e0669b71048475ddb03f5f1dba --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/MultiModalEmbedding.md @@ -0,0 +1,139 @@ +--- +id: "MultiModalEmbedding" +title: "Class: MultiModalEmbedding" +sidebar_label: "MultiModalEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseEmbedding`](BaseEmbedding.md) + + ↳ **`MultiModalEmbedding`** + + ↳↳ [`ClipEmbedding`](ClipEmbedding.md) + +## Constructors + +### constructor + +• **new MultiModalEmbedding**() + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor) + +## Methods + +### getImageEmbedding + +▸ `Abstract` **getImageEmbedding**(`images`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------- | :--------------------------- | +| `images` | [`ImageType`](../#imagetype) | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/MultiModalEmbedding.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/MultiModalEmbedding.ts#L9) + +--- + +### getImageEmbeddings + +▸ **getImageEmbeddings**(`images`): `Promise`<`number`[][]\> + +#### Parameters + +| Name | Type | +| :------- | :----------------------------- | +| `images` | [`ImageType`](../#imagetype)[] | + +#### Returns + +`Promise`<`number`[][]\> + +#### Defined in + +[packages/core/src/embeddings/MultiModalEmbedding.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/MultiModalEmbedding.ts#L11) + +--- + +### getQueryEmbedding + +▸ `Abstract` **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding) + +#### Defined in + +[packages/core/src/embeddings/types.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L23) + +--- + +### getTextEmbedding + +▸ `Abstract` **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding) + +#### Defined in + +[packages/core/src/embeddings/types.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L22) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[similarity](BaseEmbedding.md#similarity) + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/NotionReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/NotionReader.md new file mode 100644 index 0000000000000000000000000000000000000000..3e3a35b5255ef5913f9b5afb6ae0c7c62178dd42 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/NotionReader.md @@ -0,0 +1,135 @@ +--- +id: "NotionReader" +title: "Class: NotionReader" +sidebar_label: "NotionReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Notion pages are retrieved recursively and converted to Document objects. +Notion Database can also be loaded, and [the serialization method can be customized](https://github.com/TomPenguin/notion-md-crawler/tree/main). + +[Note] To use this reader, must be created the Notion integration must be created in advance +Please refer to [this document](https://www.notion.so/help/create-integrations-with-the-notion-api) for details. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new NotionReader**(`options`) + +Constructor for the NotionReader class + +#### Parameters + +| Name | Type | Description | +| :-------- | :-------------------- | :----------------------------------- | +| `options` | `NotionReaderOptions` | Configuration options for the reader | + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/NotionReader.ts#L33) + +## Properties + +### crawl + +• `Private` **crawl**: (`rootPageId`: `string`) => `Promise`<`Pages`\> + +#### Type declaration + +▸ (`rootPageId`): `Promise`<`Pages`\> + +##### Parameters + +| Name | Type | +| :----------- | :------- | +| `rootPageId` | `string` | + +##### Returns + +`Promise`<`Pages`\> + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/NotionReader.ts#L27) + +## Methods + +### loadData + +▸ **loadData**(`rootPageId`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Loads recursively Notion pages and converts them to an array of Document objects + +#### Parameters + +| Name | Type | Description | +| :----------- | :------- | :---------------------- | +| `rootPageId` | `string` | The root Notion page ID | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +A Promise that resolves to an array of Document objects + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/NotionReader.ts#L63) + +--- + +### loadPages + +▸ **loadPages**(`rootPageId`): `Promise`<`Pages`\> + +Loads recursively the Notion page with the specified root page ID. + +#### Parameters + +| Name | Type | Description | +| :----------- | :------- | :---------------------- | +| `rootPageId` | `string` | The root Notion page ID | + +#### Returns + +`Promise`<`Pages`\> + +A Promise that resolves to a Pages object(Convertible with the `toDocuments` method) + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/NotionReader.ts#L54) + +--- + +### toDocuments + +▸ **toDocuments**(`pages`): [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] + +Converts Pages to an array of Document objects + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :-------------------------------------------------------- | +| `pages` | `Pages` | The Notion pages to convert (Return value of `loadPages`) | + +#### Returns + +[`Document`](Document.md)<[`Metadata`](../#metadata)\>[] + +An array of Document objects + +#### Defined in + +[packages/core/src/readers/NotionReader.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/NotionReader.ts#L42) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/OpenAI.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/OpenAI.md new file mode 100644 index 0000000000000000000000000000000000000000..6f7a12638e7eb25d8e43491423332945d7d1d976 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/OpenAI.md @@ -0,0 +1,338 @@ +--- +id: "OpenAI" +title: "Class: OpenAI" +sidebar_label: "OpenAI" +sidebar_position: 0 +custom_edit_url: null +--- + +OpenAI LLM implementation + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new OpenAI**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------------- | +| `init?` | `Partial`<[`OpenAI`](OpenAI.md)\> & { `azure?`: `AzureOpenAIConfig` } | + +#### Defined in + +[packages/core/src/llm/LLM.ts:152](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L152) + +## Properties + +### additionalChatOptions + +• `Optional` **additionalChatOptions**: `Omit`<`Partial`<`ChatCompletionCreateParams`\>, `"model"` \| `"temperature"` \| `"max_tokens"` \| `"messages"` \| `"top_p"` \| `"streaming"`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L135) + +--- + +### additionalSessionOptions + +• `Optional` **additionalSessionOptions**: `Omit`<`Partial`<`ClientOptions`\>, `"apiKey"` \| `"timeout"` \| `"maxRetries"`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L145) + +--- + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L141) + +--- + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:150](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L150) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` = `true` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:128](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L128) + +--- + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L142) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L134) + +--- + +### model + +• **model**: `"gpt-3.5-turbo"` \| `"gpt-3.5-turbo-1106"` \| `"gpt-3.5-turbo-16k"` \| `"gpt-4"` \| `"gpt-4-32k"` \| `"gpt-4-1106-preview"` \| `"gpt-4-vision-preview"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L131) + +--- + +### session + +• **session**: `OpenAISession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L144) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:132](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L132) + +--- + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L143) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L133) + +## Accessors + +### metadata + +• `get` **metadata**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `contextWindow` | `number` | +| `maxTokens` | `undefined` \| `number` | +| `model` | `"gpt-3.5-turbo"` \| `"gpt-3.5-turbo-1106"` \| `"gpt-3.5-turbo-16k"` \| `"gpt-4"` \| `"gpt-4-32k"` \| `"gpt-4-1106-preview"` \| `"gpt-4-vision-preview"` | +| `temperature` | `number` | +| `tokenizer` | [`CL100K_BASE`](../enums/Tokenizers.md#cl100k_base) | +| `topP` | `number` | + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:206](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L206) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:249](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L249) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:286](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L286) + +--- + +### mapMessageType + +▸ **mapMessageType**(`messageType`): `"function"` \| `"user"` \| `"assistant"` \| `"system"` + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------- | +| `messageType` | [`MessageType`](../#messagetype) | + +#### Returns + +`"function"` \| `"user"` \| `"assistant"` \| `"system"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:232](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L232) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`messages`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:300](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L300) + +--- + +### streamComplete + +▸ `Protected` **streamComplete**(`query`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:362](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L362) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L217) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/OpenAIEmbedding.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/OpenAIEmbedding.md new file mode 100644 index 0000000000000000000000000000000000000000..6c380b62d2ef3713476b675f0ff0489ffb51427f --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/OpenAIEmbedding.md @@ -0,0 +1,187 @@ +--- +id: "OpenAIEmbedding" +title: "Class: OpenAIEmbedding" +sidebar_label: "OpenAIEmbedding" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseEmbedding`](BaseEmbedding.md) + + ↳ **`OpenAIEmbedding`** + +## Constructors + +### constructor + +• **new OpenAIEmbedding**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------------------------------------- | +| `init?` | `Partial`<[`OpenAIEmbedding`](OpenAIEmbedding.md)\> & { `azure?`: `AzureOpenAIConfig` } | + +#### Overrides + +[BaseEmbedding](BaseEmbedding.md).[constructor](BaseEmbedding.md#constructor) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L30) + +## Properties + +### additionalSessionOptions + +• `Optional` **additionalSessionOptions**: `Omit`<`Partial`<`ClientOptions`\>, `"apiKey"` \| `"timeout"` \| `"maxRetries"`\> + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L23) + +--- + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L20) + +--- + +### maxRetries + +• **maxRetries**: `number` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L21) + +--- + +### model + +• **model**: [`TEXT_EMBED_ADA_002`](../enums/OpenAIEmbeddingModelType.md#text_embed_ada_002) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L17) + +--- + +### session + +• **session**: `OpenAISession` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L28) + +--- + +### timeout + +• `Optional` **timeout**: `number` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L22) + +## Methods + +### getOpenAIEmbedding + +▸ `Private` **getOpenAIEmbedding**(`input`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `input` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L76) + +--- + +### getQueryEmbedding + +▸ **getQueryEmbedding**(`query`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[BaseEmbedding](BaseEmbedding.md).[getQueryEmbedding](BaseEmbedding.md#getqueryembedding) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L89) + +--- + +### getTextEmbedding + +▸ **getTextEmbedding**(`text`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Overrides + +[BaseEmbedding](BaseEmbedding.md).[getTextEmbedding](BaseEmbedding.md#gettextembedding) + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L85) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------------------- | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](../enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +#### Inherited from + +[BaseEmbedding](BaseEmbedding.md).[similarity](BaseEmbedding.md#similarity) + +#### Defined in + +[packages/core/src/embeddings/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PDFReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PDFReader.md new file mode 100644 index 0000000000000000000000000000000000000000..381694dd3d6cf637e5d0e2b12415561e2dd2c933 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PDFReader.md @@ -0,0 +1,44 @@ +--- +id: "PDFReader" +title: "Class: PDFReader" +sidebar_label: "PDFReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read the text of a PDF + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new PDFReader**() + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----- | :-------------------------------------------------------- | :------------ | +| `file` | `string` | `undefined` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/PDFReader.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/PDFReader.ts#L11) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PapaCSVReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PapaCSVReader.md new file mode 100644 index 0000000000000000000000000000000000000000..cff551fcbb311f9cc5729f83e8c244051e388c5d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PapaCSVReader.md @@ -0,0 +1,105 @@ +--- +id: "PapaCSVReader" +title: "Class: PapaCSVReader" +sidebar_label: "PapaCSVReader" +sidebar_position: 0 +custom_edit_url: null +--- + +papaparse-based csv parser + +**`Implements`** + +BaseReader + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new PapaCSVReader**(`concatRows?`, `colJoiner?`, `rowJoiner?`, `papaConfig?`) + +Constructs a new instance of the class. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :--------------------------------- | :------------ | :-------------------------------------------------------------------------------------------------------------------------- | +| `concatRows?` | `boolean` | `true` | whether to concatenate all rows into one document.If set to False, a Document will be created for each row.True by default. | +| `colJoiner?` | `string` | `", "` | - | +| `rowJoiner?` | `string` | `"\n"` | Separator to use for joining each row.Only used when `concat_rows=True`.Set to "\n" by default. | +| `papaConfig?` | `ParseConfig`<`any`, `undefined`\> | `undefined` | - | + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/CSVReader.ts#L23) + +## Properties + +### colJoiner + +• `Private` **colJoiner**: `string` + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/CSVReader.ts#L13) + +--- + +### concatRows + +• `Private` **concatRows**: `boolean` + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/CSVReader.ts#L12) + +--- + +### papaConfig + +• `Private` `Optional` **papaConfig**: `ParseConfig`<`any`, `undefined`\> + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/CSVReader.ts#L15) + +--- + +### rowJoiner + +• `Private` **rowJoiner**: `string` + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/CSVReader.ts#L14) + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Loads data from csv files + +#### Parameters + +| Name | Type | Default value | Description | +| :----- | :-------------------------------------------------------- | :------------ | :------------------------------------------- | +| `file` | `string` | `undefined` | The path to the file to load. | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | The file system to use for reading the file. | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/CSVReader.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/CSVReader.ts#L41) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Portkey.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Portkey.md new file mode 100644 index 0000000000000000000000000000000000000000..434330f4cb42ea741000355639e96089ed2ed5dd --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Portkey.md @@ -0,0 +1,261 @@ +--- +id: "Portkey" +title: "Class: Portkey" +sidebar_label: "Portkey" +sidebar_position: 0 +custom_edit_url: null +--- + +Unified language model interface + +## Implements + +- [`LLM`](../interfaces/LLM.md) + +## Constructors + +### constructor + +• **new Portkey**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------- | +| `init?` | `Partial`<[`Portkey`](Portkey.md)\> | + +#### Defined in + +[packages/core/src/llm/LLM.ts:812](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L812) + +## Properties + +### apiKey + +• `Optional` **apiKey**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:805](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L805) + +--- + +### baseURL + +• `Optional` **baseURL**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:806](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L806) + +--- + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](CallbackManager.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:810](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L810) + +--- + +### hasStreaming + +• **hasStreaming**: `boolean` = `true` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[hasStreaming](../interfaces/LLM.md#hasstreaming) + +#### Defined in + +[packages/core/src/llm/LLM.ts:803](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L803) + +--- + +### llms + +• `Optional` **llms**: `null` \| [`LLMOptions`] = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:808](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L808) + +--- + +### mode + +• `Optional` **mode**: `string` = `undefined` + +#### Defined in + +[packages/core/src/llm/LLM.ts:807](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L807) + +--- + +### session + +• **session**: `PortkeySession` + +#### Defined in + +[packages/core/src/llm/LLM.ts:809](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L809) + +## Accessors + +### metadata + +• `get` **metadata**(): [`LLMMetadata`](../interfaces/LLMMetadata.md) + +#### Returns + +[`LLMMetadata`](../interfaces/LLMMetadata.md) + +#### Implementation of + +[LLM](../interfaces/LLM.md).[metadata](../interfaces/LLM.md#metadata) + +#### Defined in + +[packages/core/src/llm/LLM.ts:830](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L830) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`, `params?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | +| `params?` | `Record`<`string`, `any`\> | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[chat](../interfaces/LLM.md#chat) + +#### Defined in + +[packages/core/src/llm/LLM.ts:834](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L834) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](../interfaces/ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[LLM](../interfaces/LLM.md).[complete](../interfaces/LLM.md#complete) + +#### Defined in + +[packages/core/src/llm/LLM.ts:858](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L858) + +--- + +### streamChat + +▸ **streamChat**(`messages`, `parentEvent?`, `params?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `params?` | `Record`<`string`, `any`\> | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:873](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L873) + +--- + +### streamComplete + +▸ **streamComplete**(`query`, `parentEvent?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:920](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L920) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `messages` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`number` + +#### Implementation of + +[LLM](../interfaces/LLM.md).[tokens](../interfaces/LLM.md#tokens) + +#### Defined in + +[packages/core/src/llm/LLM.ts:826](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L826) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PromptHelper.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PromptHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..95782295dbf21ea601b2d6c4b1678583322af188 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/PromptHelper.md @@ -0,0 +1,198 @@ +--- +id: "PromptHelper" +title: "Class: PromptHelper" +sidebar_label: "PromptHelper" +sidebar_position: 0 +custom_edit_url: null +--- + +A collection of helper functions for working with prompts. + +## Constructors + +### constructor + +• **new PromptHelper**(`contextWindow?`, `numOutput?`, `chunkOverlapRatio?`, `chunkSizeLimit?`, `tokenizer?`, `separator?`) + +#### Parameters + +| Name | Type | Default value | +| :------------------ | :---------------------------------- | :---------------------------- | +| `contextWindow` | `number` | `DEFAULT_CONTEXT_WINDOW` | +| `numOutput` | `number` | `DEFAULT_NUM_OUTPUTS` | +| `chunkOverlapRatio` | `number` | `DEFAULT_CHUNK_OVERLAP_RATIO` | +| `chunkSizeLimit?` | `number` | `undefined` | +| `tokenizer?` | (`text`: `string`) => `Uint32Array` | `undefined` | +| `separator` | `string` | `" "` | + +#### Defined in + +[packages/core/src/PromptHelper.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L40) + +## Properties + +### chunkOverlapRatio + +• **chunkOverlapRatio**: `number` = `DEFAULT_CHUNK_OVERLAP_RATIO` + +#### Defined in + +[packages/core/src/PromptHelper.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L35) + +--- + +### chunkSizeLimit + +• `Optional` **chunkSizeLimit**: `number` + +#### Defined in + +[packages/core/src/PromptHelper.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L36) + +--- + +### contextWindow + +• **contextWindow**: `number` = `DEFAULT_CONTEXT_WINDOW` + +#### Defined in + +[packages/core/src/PromptHelper.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L33) + +--- + +### numOutput + +• **numOutput**: `number` = `DEFAULT_NUM_OUTPUTS` + +#### Defined in + +[packages/core/src/PromptHelper.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L34) + +--- + +### separator + +• **separator**: `string` = `" "` + +#### Defined in + +[packages/core/src/PromptHelper.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L38) + +--- + +### tokenizer + +• **tokenizer**: (`text`: `string`) => `Uint32Array` + +#### Type declaration + +▸ (`text`): `Uint32Array` + +##### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +##### Returns + +`Uint32Array` + +#### Defined in + +[packages/core/src/PromptHelper.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L37) + +## Methods + +### getAvailableChunkSize + +▸ `Private` **getAvailableChunkSize**(`prompt`, `numChunks?`, `padding?`): `number` + +Find the maximum size of each chunk given a prompt. + +#### Parameters + +| Name | Type | Default value | +| :---------- | :--------------------------------- | :------------ | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | `undefined` | +| `numChunks` | `number` | `1` | +| `padding` | `number` | `5` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/PromptHelper.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L76) + +--- + +### getAvailableContextSize + +▸ `Private` **getAvailableContextSize**(`prompt`): `number` + +Given a prompt, return the maximum size of the inputs to the prompt. + +#### Parameters + +| Name | Type | +| :------- | :--------------------------------- | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/PromptHelper.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L61) + +--- + +### getTextSplitterGivenPrompt + +▸ **getTextSplitterGivenPrompt**(`prompt`, `numChunks?`, `padding?`): [`SentenceSplitter`](SentenceSplitter.md) + +Creates a text splitter with the correct chunk sizes and overlaps given a prompt. + +#### Parameters + +| Name | Type | Default value | +| :---------- | :--------------------------------- | :---------------- | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | `undefined` | +| `numChunks` | `number` | `1` | +| `padding` | `number` | `DEFAULT_PADDING` | + +#### Returns + +[`SentenceSplitter`](SentenceSplitter.md) + +#### Defined in + +[packages/core/src/PromptHelper.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L99) + +--- + +### repack + +▸ **repack**(`prompt`, `textChunks`, `padding?`): `string`[] + +Repack resplits the strings based on the optimal text splitter. + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------------------------------- | :---------------- | +| `prompt` | [`SimplePrompt`](../#simpleprompt) | `undefined` | +| `textChunks` | `string`[] | `undefined` | +| `padding` | `number` | `DEFAULT_PADDING` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/PromptHelper.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L120) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Refine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Refine.md new file mode 100644 index 0000000000000000000000000000000000000000..41e227f06dbcb2d569b5a1bd6ab90daba6da08b6 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Refine.md @@ -0,0 +1,167 @@ +--- +id: "Refine" +title: "Class: Refine" +sidebar_label: "Refine" +sidebar_position: 0 +custom_edit_url: null +--- + +A response builder that uses the query to ask the LLM generate a better response using multiple text chunks. + +## Hierarchy + +- **`Refine`** + + ↳ [`CompactAndRefine`](CompactAndRefine.md) + +## Implements + +- `BaseResponseBuilder` + +## Constructors + +### constructor + +• **new Refine**(`serviceContext`, `textQATemplate?`, `refineTemplate?`) + +#### Parameters + +| Name | Type | +| :---------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `textQATemplate?` | (`__namedParameters`: `Object`) => `string` | +| `refineTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:82](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L82) + +## Properties + +### refineTemplate + +• **refineTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L80) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L78) + +--- + +### textQATemplate + +• **textQATemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:79](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L79) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`, `prevResponse?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :-------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `prevResponse?` | `string` | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +BaseResponseBuilder.getResponse + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L92) + +--- + +### giveResponseSingle + +▸ `Private` **giveResponseSingle**(`queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `queryStr` | `string` | +| `textChunk` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L117) + +--- + +### refineResponseSingle + +▸ `Private` **refineResponseSingle**(`response`, `queryStr`, `textChunk`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `response` | `string` | +| `queryStr` | `string` | +| `textChunk` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:153](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L153) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Response.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Response.md new file mode 100644 index 0000000000000000000000000000000000000000..38dbd9f46249e42bdc9b913536f332596b892fe7 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/Response.md @@ -0,0 +1,74 @@ +--- +id: "Response" +title: "Class: Response" +sidebar_label: "Response" +sidebar_position: 0 +custom_edit_url: null +--- + +Respone is the output of a LLM + +## Constructors + +### constructor + +• **new Response**(`response`, `sourceNodes?`) + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------- | +| `response` | `string` | +| `sourceNodes?` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Defined in + +[packages/core/src/Response.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Response.ts#L10) + +## Properties + +### response + +• **response**: `string` + +#### Defined in + +[packages/core/src/Response.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Response.ts#L7) + +--- + +### sourceNodes + +• `Optional` **sourceNodes**: [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/Response.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Response.ts#L8) + +## Methods + +### getFormattedSources + +▸ **getFormattedSources**(): `void` + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/Response.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Response.ts#L15) + +--- + +### toString + +▸ **toString**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Response.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Response.ts#L19) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ResponseSynthesizer.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ResponseSynthesizer.md new file mode 100644 index 0000000000000000000000000000000000000000..c058000c1834c424f7d9d043f97b43002464eaa7 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/ResponseSynthesizer.md @@ -0,0 +1,80 @@ +--- +id: "ResponseSynthesizer" +title: "Class: ResponseSynthesizer" +sidebar_label: "ResponseSynthesizer" +sidebar_position: 0 +custom_edit_url: null +--- + +A ResponseSynthesizer is used to generate a response from a query and a list of nodes. + +## Constructors + +### constructor + +• **new ResponseSynthesizer**(`«destructured»?`) + +#### Parameters + +| Name | Type | +| :------------------- | :-------------------------------------------------- | +| `«destructured»` | `Object` | +| › `metadataMode?` | [`MetadataMode`](../enums/MetadataMode.md) | +| › `responseBuilder?` | `BaseResponseBuilder` | +| › `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:295](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L295) + +## Properties + +### metadataMode + +• **metadataMode**: [`MetadataMode`](../enums/MetadataMode.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:293](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L293) + +--- + +### responseBuilder + +• **responseBuilder**: `BaseResponseBuilder` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:291](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L291) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:292](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L292) + +## Methods + +### synthesize + +▸ **synthesize**(`query`, `nodesWithScore`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------------------------------- | +| `query` | `string` | +| `nodesWithScore` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`Response`](Response.md)\> + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:310](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L310) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/RetrieverQueryEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/RetrieverQueryEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..8007a55c694ec1ec15c364b15b7d3e21a31ac1b1 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/RetrieverQueryEngine.md @@ -0,0 +1,140 @@ +--- +id: "RetrieverQueryEngine" +title: "Class: RetrieverQueryEngine" +sidebar_label: "RetrieverQueryEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +A query engine that uses a retriever to query an index and then synthesizes the response. + +## Implements + +- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +## Constructors + +### constructor + +• **new RetrieverQueryEngine**(`retriever`, `responseSynthesizer?`, `preFilters?`, `nodePostprocessors?`) + +#### Parameters + +| Name | Type | +| :--------------------- | :------------------------------------------------------------------ | +| `retriever` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | +| `responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | +| `preFilters?` | `unknown` | +| `nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | + +#### Defined in + +[packages/core/src/QueryEngine.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L37) + +## Properties + +### nodePostprocessors + +• **nodePostprocessors**: [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] + +#### Defined in + +[packages/core/src/QueryEngine.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L34) + +--- + +### preFilters + +• `Optional` **preFilters**: `unknown` + +#### Defined in + +[packages/core/src/QueryEngine.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L35) + +--- + +### responseSynthesizer + +• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L33) + +--- + +### retriever + +• **retriever**: [`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L32) + +## Methods + +### applyNodePostprocessors + +▸ `Private` **applyNodePostprocessors**(`nodes`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/QueryEngine.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L52) + +--- + +### query + +▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](Response.md)\> + +Query the query engine and get a response. + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`Response`](Response.md)\> + +#### Implementation of + +[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query) + +#### Defined in + +[packages/core/src/QueryEngine.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L69) + +--- + +### retrieve + +▸ `Private` **retrieve**(`query`, `parentEvent`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------- | +| `query` | `string` | +| `parentEvent` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L59) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SentenceSplitter.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SentenceSplitter.md new file mode 100644 index 0000000000000000000000000000000000000000..a8a0205a872e022a837338424c9b5584ee29e5ba --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SentenceSplitter.md @@ -0,0 +1,271 @@ +--- +id: "SentenceSplitter" +title: "Class: SentenceSplitter" +sidebar_label: "SentenceSplitter" +sidebar_position: 0 +custom_edit_url: null +--- + +SentenceSplitter is our default text splitter that supports splitting into sentences, paragraphs, or fixed length chunks with overlap. + +One of the advantages of SentenceSplitter is that even in the fixed length chunks it will try to keep sentences together. + +## Constructors + +### constructor + +• **new SentenceSplitter**(`options?`) + +#### Parameters + +| Name | Type | +| :----------------------------- | :------------------------------------------------- | +| `options?` | `Object` | +| `options.chunkOverlap?` | `number` | +| `options.chunkSize?` | `number` | +| `options.chunkingTokenizerFn?` | (`text`: `string`) => `null` \| `RegExpMatchArray` | +| `options.paragraphSeparator?` | `string` | +| `options.splitLongSentences?` | `boolean` | +| `options.tokenizer?` | `any` | +| `options.tokenizerDecoder?` | `any` | + +#### Defined in + +[packages/core/src/TextSplitter.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L67) + +## Properties + +### chunkOverlap + +• `Private` **chunkOverlap**: `number` + +#### Defined in + +[packages/core/src/TextSplitter.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L60) + +--- + +### chunkSize + +• `Private` **chunkSize**: `number` + +#### Defined in + +[packages/core/src/TextSplitter.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L59) + +--- + +### chunkingTokenizerFn + +• `Private` **chunkingTokenizerFn**: (`text`: `string`) => `null` \| `RegExpMatchArray` + +#### Type declaration + +▸ (`text`): `null` \| `RegExpMatchArray` + +##### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +##### Returns + +`null` \| `RegExpMatchArray` + +#### Defined in + +[packages/core/src/TextSplitter.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L64) + +--- + +### paragraphSeparator + +• `Private` **paragraphSeparator**: `string` + +#### Defined in + +[packages/core/src/TextSplitter.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L63) + +--- + +### splitLongSentences + +• `Private` **splitLongSentences**: `boolean` + +#### Defined in + +[packages/core/src/TextSplitter.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L65) + +--- + +### tokenizer + +• `Private` **tokenizer**: `any` + +#### Defined in + +[packages/core/src/TextSplitter.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L61) + +--- + +### tokenizerDecoder + +• `Private` **tokenizerDecoder**: `any` + +#### Defined in + +[packages/core/src/TextSplitter.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L62) + +## Methods + +### combineTextSplits + +▸ **combineTextSplits**(`newSentenceSplits`, `effectiveChunkSize`): `TextSplit`[] + +#### Parameters + +| Name | Type | +| :------------------- | :----------- | +| `newSentenceSplits` | `SplitRep`[] | +| `effectiveChunkSize` | `number` | + +#### Returns + +`TextSplit`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L205) + +--- + +### getEffectiveChunkSize + +▸ `Private` **getEffectiveChunkSize**(`extraInfoStr?`): `number` + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `extraInfoStr?` | `string` | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/TextSplitter.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L104) + +--- + +### getParagraphSplits + +▸ **getParagraphSplits**(`text`, `effectiveChunkSize?`): `string`[] + +#### Parameters + +| Name | Type | +| :-------------------- | :------- | +| `text` | `string` | +| `effectiveChunkSize?` | `number` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L121) + +--- + +### getSentenceSplits + +▸ **getSentenceSplits**(`text`, `effectiveChunkSize?`): `string`[] + +#### Parameters + +| Name | Type | +| :-------------------- | :------- | +| `text` | `string` | +| `effectiveChunkSize?` | `number` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:147](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L147) + +--- + +### processSentenceSplits + +▸ `Private` **processSentenceSplits**(`sentenceSplits`, `effectiveChunkSize`): `SplitRep`[] + +Splits sentences into chunks if necessary. + +This isn't great behavior because it can split down the middle of a +word or in non-English split down the middle of a Unicode codepoint +so the splitting is turned off by default. If you need it, please +set the splitLongSentences option to true. + +#### Parameters + +| Name | Type | +| :------------------- | :--------- | +| `sentenceSplits` | `string`[] | +| `effectiveChunkSize` | `number` | + +#### Returns + +`SplitRep`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L176) + +--- + +### splitText + +▸ **splitText**(`text`, `extraInfoStr?`): `string`[] + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `text` | `string` | +| `extraInfoStr?` | `string` | + +#### Returns + +`string`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:297](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L297) + +--- + +### splitTextWithOverlaps + +▸ **splitTextWithOverlaps**(`text`, `extraInfoStr?`): `TextSplit`[] + +#### Parameters + +| Name | Type | +| :-------------- | :------- | +| `text` | `string` | +| `extraInfoStr?` | `string` | + +#### Returns + +`TextSplit`[] + +#### Defined in + +[packages/core/src/TextSplitter.ts:269](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L269) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimilarityPostprocessor.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimilarityPostprocessor.md new file mode 100644 index 0000000000000000000000000000000000000000..2419d5477b176dfd75581b703c0f6fa466b5fa8d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimilarityPostprocessor.md @@ -0,0 +1,62 @@ +--- +id: "SimilarityPostprocessor" +title: "Class: SimilarityPostprocessor" +sidebar_label: "SimilarityPostprocessor" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md) + +## Constructors + +### constructor + +• **new SimilarityPostprocessor**(`options?`) + +#### Parameters + +| Name | Type | +| :-------------------------- | :------- | +| `options?` | `Object` | +| `options.similarityCutoff?` | `number` | + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseNodePostprocessor.ts#L10) + +## Properties + +### similarityCutoff + +• `Optional` **similarityCutoff**: `number` + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseNodePostprocessor.ts#L8) + +## Methods + +### postprocessNodes + +▸ **postprocessNodes**(`nodes`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Implementation of + +[BaseNodePostprocessor](../interfaces/BaseNodePostprocessor.md).[postprocessNodes](../interfaces/BaseNodePostprocessor.md#postprocessnodes) + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseNodePostprocessor.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleChatEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..a01a3bf20f377939df12425f99bc847d39efb511 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleChatEngine.md @@ -0,0 +1,125 @@ +--- +id: "SimpleChatEngine" +title: "Class: SimpleChatEngine" +sidebar_label: "SimpleChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +SimpleChatEngine is the simplest possible chat engine. Useful for using your own custom prompts. + +## Implements + +- [`ChatEngine`](../interfaces/ChatEngine.md) + +## Constructors + +### constructor + +• **new SimpleChatEngine**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------------------------- | +| `init?` | `Partial`<[`SimpleChatEngine`](SimpleChatEngine.md)\> | + +#### Defined in + +[packages/core/src/ChatEngine.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L51) + +## Properties + +### chatHistory + +• **chatHistory**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L48) + +--- + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L49) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :---------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[chat](../interfaces/ChatEngine.md#chat) + +#### Defined in + +[packages/core/src/ChatEngine.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L56) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatEngine](../interfaces/ChatEngine.md).[reset](../interfaces/ChatEngine.md#reset) + +#### Defined in + +[packages/core/src/ChatEngine.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L101) + +--- + +### streamChat + +▸ `Protected` **streamChat**(`message`, `chatHistory?`): `AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Parameters + +| Name | Type | +| :------------- | :---------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | +| `chatHistory?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`AsyncGenerator`<`string`, `void`, `unknown`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:78](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L78) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleChatHistory.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleChatHistory.md new file mode 100644 index 0000000000000000000000000000000000000000..8ffeee116e60e583f77929699cbeef9024a942e6 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleChatHistory.md @@ -0,0 +1,145 @@ +--- +id: "SimpleChatHistory" +title: "Class: SimpleChatHistory" +sidebar_label: "SimpleChatHistory" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatHistory is used to keep the state of back and forth chat messages + +## Implements + +- [`ChatHistory`](../interfaces/ChatHistory.md) + +## Constructors + +### constructor + +• **new SimpleChatHistory**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------ | +| `init?` | `Partial`<[`SimpleChatHistory`](SimpleChatHistory.md)\> | + +#### Defined in + +[packages/core/src/ChatHistory.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L39) + +## Properties + +### messages + +• **messages**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[messages](../interfaces/ChatHistory.md#messages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L36) + +--- + +### messagesBefore + +• `Private` **messagesBefore**: `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L37) + +## Methods + +### addMessage + +▸ **addMessage**(`message`): `void` + +Adds a message to the chat history. + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------- | +| `message` | [`ChatMessage`](../interfaces/ChatMessage.md) | + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[addMessage](../interfaces/ChatHistory.md#addmessage) + +#### Defined in + +[packages/core/src/ChatHistory.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L44) + +--- + +### newMessages + +▸ **newMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +Returns the new messages since the last call to this function (or since calling the constructor) + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[newMessages](../interfaces/ChatHistory.md#newmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L56) + +--- + +### requestMessages + +▸ **requestMessages**(`transientMessages?`): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +Returns the messages that should be used as input to the LLM. + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `transientMessages?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[requestMessages](../interfaces/ChatHistory.md#requestmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L48) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[reset](../interfaces/ChatHistory.md#reset) + +#### Defined in + +[packages/core/src/ChatHistory.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L52) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleDirectoryReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleDirectoryReader.md new file mode 100644 index 0000000000000000000000000000000000000000..350945ebf17e4f1220304211c33c6093e0867a39 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleDirectoryReader.md @@ -0,0 +1,88 @@ +--- +id: "SimpleDirectoryReader" +title: "Class: SimpleDirectoryReader" +sidebar_label: "SimpleDirectoryReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read all of the documents in a directory. +By default, supports the list of file types +in the FILE_EXT_TO_READER map. + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new SimpleDirectoryReader**(`observer?`) + +#### Parameters + +| Name | Type | +| :---------- | :--------------- | +| `observer?` | `ReaderCallback` | + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L65) + +## Properties + +### observer + +• `Private` `Optional` **observer**: `ReaderCallback` + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L65) + +## Methods + +### doObserverCheck + +▸ `Private` **doObserverCheck**(`category`, `name`, `status`, `message?`): `boolean` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------ | +| `category` | `"file"` \| `"directory"` | +| `name` | `string` | +| `status` | `ReaderStatus` | +| `message?` | `string` | + +#### Returns + +`boolean` + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:135](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L135) + +--- + +### loadData + +▸ **loadData**(`«destructured»`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------------------------------------------------------------- | +| `«destructured»` | [`SimpleDirectoryReaderLoadDataProps`](../#simpledirectoryreaderloaddataprops) | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L67) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleDocumentStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleDocumentStore.md new file mode 100644 index 0000000000000000000000000000000000000000..7b660c446fe6450198dcb3c376be75cac459142f --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleDocumentStore.md @@ -0,0 +1,480 @@ +--- +id: "SimpleDocumentStore" +title: "Class: SimpleDocumentStore" +sidebar_label: "SimpleDocumentStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `KVDocumentStore` + + ↳ **`SimpleDocumentStore`** + +## Constructors + +### constructor + +• **new SimpleDocumentStore**(`kvStore?`, `namespace?`) + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------------- | +| `kvStore?` | [`SimpleKVStore`](SimpleKVStore.md) | +| `namespace?` | `string` | + +#### Overrides + +KVDocumentStore.constructor + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L19) + +## Properties + +### kvStore + +• `Private` **kvStore**: [`SimpleKVStore`](SimpleKVStore.md) + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L17) + +## Methods + +### addDocuments + +▸ **addDocuments**(`docs`, `allowUpdate?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :------------------------------------------------------- | :------------ | +| `docs` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | `undefined` | +| `allowUpdate` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.addDocuments + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L33) + +--- + +### deleteDocument + +▸ **deleteDocument**(`docId`, `raiseError?`, `removeRefDocNode?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :----------------- | :-------- | :------------ | +| `docId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | +| `removeRefDocNode` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.deleteDocument + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L131) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `raiseError?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `refDocId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.deleteRefDoc + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:148](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L148) + +--- + +### docs + +▸ **docs**(): `Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Returns + +`Promise`<`Record`<`string`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Inherited from + +KVDocumentStore.docs + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L24) + +--- + +### documentExists + +▸ **documentExists**(`docId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +KVDocumentStore.documentExists + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:105](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L105) + +--- + +### getAllRefDocInfo + +▸ **getAllRefDocInfo**(): `Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Returns + +`Promise`<`undefined` \| `Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Inherited from + +KVDocumentStore.getAllRefDocInfo + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:93](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L93) + +--- + +### getDocument + +▸ **getDocument**(`docId`, `raiseError?`): `Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `docId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<`undefined` \| [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Inherited from + +KVDocumentStore.getDocument + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L73) + +--- + +### getDocumentHash + +▸ **getDocumentHash**(`docId`): `Promise`<`undefined` \| `string`\> + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `docId` | `string` | + +#### Returns + +`Promise`<`undefined` \| `string`\> + +#### Inherited from + +KVDocumentStore.getDocumentHash + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:174](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L174) + +--- + +### getNode + +▸ **getNode**(`nodeId`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------- | :------------ | +| `nodeId` | `string` | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\> + +#### Inherited from + +KVDocumentStore.getNode + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L57) + +--- + +### getNodeDict + +▸ **getNodeDict**(`nodeIdDict`): `Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Parameters + +| Name | Type | +| :----------- | :------- | +| `nodeIdDict` | `Object` | + +#### Returns + +`Promise`<`Record`<`number`, [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>\>\> + +#### Inherited from + +KVDocumentStore.getNodeDict + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L65) + +--- + +### getNodes + +▸ **getNodes**(`nodeIds`, `raiseError?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :--------- | :------------ | +| `nodeIds` | `string`[] | `undefined` | +| `raiseError` | `boolean` | `true` | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Inherited from + +KVDocumentStore.getNodes + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L51) + +--- + +### getRefDocInfo + +▸ **getRefDocInfo**(`refDocId`): `Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`RefDocInfo`](../interfaces/RefDocInfo.md)\> + +#### Inherited from + +KVDocumentStore.getRefDocInfo + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L88) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +KVDocumentStore.persist + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L52) + +--- + +### refDocExists + +▸ **refDocExists**(`refDocId`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`boolean`\> + +#### Inherited from + +KVDocumentStore.refDocExists + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:101](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L101) + +--- + +### setDocumentHash + +▸ **setDocumentHash**(`docId`, `docHash`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------- | :------- | +| `docId` | `string` | +| `docHash` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVDocumentStore.setDocumentHash + +#### Defined in + +[packages/core/src/storage/docStore/KVDocumentStore.ts:169](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/KVDocumentStore.ts#L169) + +--- + +### toDict + +▸ **toDict**(): `SaveDict` + +#### Returns + +`SaveDict` + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L73) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`, `namespace?`): [`SimpleDocumentStore`](SimpleDocumentStore.md) + +#### Parameters + +| Name | Type | +| :----------- | :--------- | +| `saveDict` | `SaveDict` | +| `namespace?` | `string` | + +#### Returns + +[`SimpleDocumentStore`](SimpleDocumentStore.md) + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L68) + +--- + +### fromPersistDir + +▸ `Static` **fromPersistDir**(`persistDir?`, `namespace?`, `fsModule?`): `Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------------------------------------------------------- | :-------------------- | +| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` | +| `namespace?` | `string` | `undefined` | +| `fsModule?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `undefined` | + +#### Returns + +`Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L26) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `namespace?`, `fs?`): `Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `namespace?` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<[`SimpleDocumentStore`](SimpleDocumentStore.md)\> + +#### Defined in + +[packages/core/src/storage/docStore/SimpleDocumentStore.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/SimpleDocumentStore.ts#L42) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleIndexStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleIndexStore.md new file mode 100644 index 0000000000000000000000000000000000000000..6dcb4227a1eb62519f057df48d9d59b5fc114eff --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleIndexStore.md @@ -0,0 +1,234 @@ +--- +id: "SimpleIndexStore" +title: "Class: SimpleIndexStore" +sidebar_label: "SimpleIndexStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `KVIndexStore` + + ↳ **`SimpleIndexStore`** + +## Constructors + +### constructor + +• **new SimpleIndexStore**(`kvStore?`) + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------------- | +| `kvStore?` | [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) | + +#### Overrides + +KVIndexStore.constructor + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L15) + +## Properties + +### kvStore + +• `Private` **kvStore**: [`BaseInMemoryKVStore`](BaseInMemoryKVStore.md) + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L13) + +## Methods + +### addIndexStruct + +▸ **addIndexStruct**(`indexStruct`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------ | +| `indexStruct` | [`IndexStruct`](IndexStruct.md) | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVIndexStore.addIndexStruct + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/KVIndexStore.ts#L17) + +--- + +### deleteIndexStruct + +▸ **deleteIndexStruct**(`key`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :---- | :------- | +| `key` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +KVIndexStore.deleteIndexStruct + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/KVIndexStore.ts#L23) + +--- + +### getIndexStruct + +▸ **getIndexStruct**(`structId?`): `Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Parameters + +| Name | Type | +| :---------- | :------- | +| `structId?` | `string` | + +#### Returns + +`Promise`<`undefined` \| [`IndexStruct`](IndexStruct.md)\> + +#### Inherited from + +KVIndexStore.getIndexStruct + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/KVIndexStore.ts#L27) + +--- + +### getIndexStructs + +▸ **getIndexStructs**(): `Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Returns + +`Promise`<[`IndexStruct`](IndexStruct.md)[]\> + +#### Inherited from + +KVIndexStore.getIndexStructs + +#### Defined in + +[packages/core/src/storage/indexStore/KVIndexStore.ts:43](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/KVIndexStore.ts#L43) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :-------------------- | +| `persistPath` | `string` | `DEFAULT_PERSIST_DIR` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +KVIndexStore.persist + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L40) + +--- + +### toDict + +▸ **toDict**(): `Record`<`string`, `unknown`\> + +#### Returns + +`Record`<`string`, `unknown`\> + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L52) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`): [`SimpleIndexStore`](SimpleIndexStore.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `saveDict` | `DataType` | + +#### Returns + +[`SimpleIndexStore`](SimpleIndexStore.md) + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L47) + +--- + +### fromPersistDir + +▸ `Static` **fromPersistDir**(`persistDir?`, `fs?`): `Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------------------------------------------------------- | :-------------------- | +| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L21) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :------------ | :-------------------------------------------------------- | :------------ | +| `persistPath` | `string` | `undefined` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`SimpleIndexStore`](SimpleIndexStore.md)\> + +#### Defined in + +[packages/core/src/storage/indexStore/SimpleIndexStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/indexStore/SimpleIndexStore.ts#L32) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleKVStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleKVStore.md new file mode 100644 index 0000000000000000000000000000000000000000..5b8805028ffc9235ebaadf00128a915eb78d8739 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleKVStore.md @@ -0,0 +1,239 @@ +--- +id: "SimpleKVStore" +title: "Class: SimpleKVStore" +sidebar_label: "SimpleKVStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`BaseKVStore`](BaseKVStore.md) + + ↳ **`SimpleKVStore`** + +## Constructors + +### constructor + +• **new SimpleKVStore**(`data?`) + +#### Parameters + +| Name | Type | +| :------ | :--------- | +| `data?` | `DataType` | + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[constructor](BaseKVStore.md#constructor) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L14) + +## Properties + +### data + +• `Private` **data**: `DataType` + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L10) + +--- + +### fs + +• `Private` **fs**: `undefined` \| [`GenericFileSystem`](../interfaces/GenericFileSystem.md) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L12) + +--- + +### persistPath + +• `Private` **persistPath**: `undefined` \| `string` + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L11) + +## Methods + +### delete + +▸ **delete**(`key`, `collection?`): `Promise`<`boolean`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `key` | `string` | `undefined` | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`boolean`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[delete](BaseKVStore.md#delete) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L52) + +--- + +### get + +▸ **get**(`key`, `collection?`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `key` | `string` | `undefined` | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`any`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[get](BaseKVStore.md#get) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L34) + +--- + +### getAll + +▸ **getAll**(`collection?`): `Promise`<`DataType`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`DataType`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[getAll](BaseKVStore.md#getall) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L48) + +--- + +### persist + +▸ **persist**(`persistPath`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L63) + +--- + +### put + +▸ **put**(`key`, `val`, `collection?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------- | :------------------- | +| `key` | `string` | `undefined` | +| `val` | `any` | `undefined` | +| `collection` | `string` | `DEFAULT_COLLECTION` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseKVStore](BaseKVStore.md).[put](BaseKVStore.md#put) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L19) + +--- + +### toDict + +▸ **toDict**(): `DataType` + +#### Returns + +`DataType` + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:99](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L99) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`): [`SimpleKVStore`](SimpleKVStore.md) + +#### Parameters + +| Name | Type | +| :--------- | :--------- | +| `saveDict` | `DataType` | + +#### Returns + +[`SimpleKVStore`](SimpleKVStore.md) + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L103) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleKVStore`](SimpleKVStore.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<[`SimpleKVStore`](SimpleKVStore.md)\> + +#### Defined in + +[packages/core/src/storage/kvStore/SimpleKVStore.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/kvStore/SimpleKVStore.ts#L73) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleMongoReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleMongoReader.md new file mode 100644 index 0000000000000000000000000000000000000000..e3bbc5f710e508d71550e68b85be144154e76001 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleMongoReader.md @@ -0,0 +1,99 @@ +--- +id: "SimpleMongoReader" +title: "Class: SimpleMongoReader" +sidebar_label: "SimpleMongoReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read in from MongoDB + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new SimpleMongoReader**(`client`) + +#### Parameters + +| Name | Type | +| :------- | :------------ | +| `client` | `MongoClient` | + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleMongoReader.ts#L11) + +## Properties + +### client + +• `Private` **client**: `MongoClient` + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleMongoReader.ts#L9) + +## Methods + +### flatten + +▸ `Private` **flatten**(`texts`): `string`[] + +Flattens an array of strings or string arrays into a single-dimensional array of strings. + +#### Parameters + +| Name | Type | Description | +| :------ | :------------------------- | :------------------------------------------------ | +| `texts` | (`string` \| `string`[])[] | The array of strings or string arrays to flatten. | + +#### Returns + +`string`[] + +The flattened array of strings. + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleMongoReader.ts#L20) + +--- + +### loadData + +▸ **loadData**(`dbName`, `collectionName`, `fieldNames?`, `separator?`, `filterQuery?`, `maxDocs?`, `metadataNames?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +Loads data from MongoDB collection + +#### Parameters + +| Name | Type | Default value | Description | +| :--------------- | :------------------------- | :------------ | :--------------------------------------------------------------------------------------------- | +| `dbName` | `string` | `undefined` | The name of the database to load. | +| `collectionName` | `string` | `undefined` | The name of the collection to load. | +| `fieldNames` | `string`[] | `undefined` | An array of field names to retrieve from each document. Defaults to ["text"]. | +| `separator` | `string` | `""` | The separator to join multiple field values. Defaults to an empty string. | +| `filterQuery` | `Record`<`string`, `any`\> | `{}` | Specific query, as specified by MongoDB NodeJS documentation. | +| `maxDocs` | `number` | `0` | The maximum number of documents to retrieve. Defaults to 0 (retrieve all documents). | +| `metadataNames?` | `string`[] | `undefined` | An optional array of metadata field names. If specified extracts this information as metadata. | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +**`Throws`** + +If a field specified in fieldNames or metadataNames is not found in a MongoDB document. + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/SimpleMongoReader.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleMongoReader.ts#L39) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleNodeParser.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleNodeParser.md new file mode 100644 index 0000000000000000000000000000000000000000..23956c8c0db42a8937bdf9d6ca61ab1ce88bec46 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleNodeParser.md @@ -0,0 +1,120 @@ +--- +id: "SimpleNodeParser" +title: "Class: SimpleNodeParser" +sidebar_label: "SimpleNodeParser" +sidebar_position: 0 +custom_edit_url: null +--- + +SimpleNodeParser is the default NodeParser. It splits documents into TextNodes using a splitter, by default SentenceSplitter + +## Implements + +- [`NodeParser`](../interfaces/NodeParser.md) + +## Constructors + +### constructor + +• **new SimpleNodeParser**(`init?`) + +#### Parameters + +| Name | Type | +| :------------------------- | :---------------------------------------- | +| `init?` | `Object` | +| `init.chunkOverlap?` | `number` | +| `init.chunkSize?` | `number` | +| `init.includeMetadata?` | `boolean` | +| `init.includePrevNextRel?` | `boolean` | +| `init.textSplitter?` | [`SentenceSplitter`](SentenceSplitter.md) | + +#### Defined in + +[packages/core/src/NodeParser.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L106) + +## Properties + +### includeMetadata + +• **includeMetadata**: `boolean` + +Whether to include metadata in the nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L100) + +--- + +### includePrevNextRel + +• **includePrevNextRel**: `boolean` + +Whether to include previous and next relationships in the nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:104](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L104) + +--- + +### textSplitter + +• **textSplitter**: [`SentenceSplitter`](SentenceSplitter.md) + +The text splitter to use. + +#### Defined in + +[packages/core/src/NodeParser.ts:96](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L96) + +## Methods + +### getNodesFromDocuments + +▸ **getNodesFromDocuments**(`documents`): ([`TextNode`](TextNode.md)<[`Metadata`](../#metadata)\> \| [`ImageDocument`](ImageDocument.md)<`any`\>)[] + +Generate Node objects from documents + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------- | +| `documents` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +([`TextNode`](TextNode.md)<[`Metadata`](../#metadata)\> \| [`ImageDocument`](ImageDocument.md)<`any`\>)[] + +#### Implementation of + +[NodeParser](../interfaces/NodeParser.md).[getNodesFromDocuments](../interfaces/NodeParser.md#getnodesfromdocuments) + +#### Defined in + +[packages/core/src/NodeParser.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L137) + +--- + +### fromDefaults + +▸ `Static` **fromDefaults**(`init?`): [`SimpleNodeParser`](SimpleNodeParser.md) + +#### Parameters + +| Name | Type | +| :------------------------- | :-------- | +| `init?` | `Object` | +| `init.chunkOverlap?` | `number` | +| `init.chunkSize?` | `number` | +| `init.includeMetadata?` | `boolean` | +| `init.includePrevNextRel?` | `boolean` | + +#### Returns + +[`SimpleNodeParser`](SimpleNodeParser.md) + +#### Defined in + +[packages/core/src/NodeParser.ts:124](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L124) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleResponseBuilder.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleResponseBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..a24e37ff804e685892ca4382c48374c56c3b32a8 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleResponseBuilder.md @@ -0,0 +1,75 @@ +--- +id: "SimpleResponseBuilder" +title: "Class: SimpleResponseBuilder" +sidebar_label: "SimpleResponseBuilder" +sidebar_position: 0 +custom_edit_url: null +--- + +A response builder that just concatenates responses. + +## Implements + +- `BaseResponseBuilder` + +## Constructors + +### constructor + +• **new SimpleResponseBuilder**(`serviceContext`) + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L53) + +## Properties + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L50) + +--- + +### textQATemplate + +• **textQATemplate**: [`SimplePrompt`](../#simpleprompt) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L51) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +BaseResponseBuilder.getResponse + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L58) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleVectorStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleVectorStore.md new file mode 100644 index 0000000000000000000000000000000000000000..d9fe133ee14d97a5983f761aeb91d9a4e5b7771b --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SimpleVectorStore.md @@ -0,0 +1,279 @@ +--- +id: "SimpleVectorStore" +title: "Class: SimpleVectorStore" +sidebar_label: "SimpleVectorStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implements + +- [`VectorStore`](../interfaces/VectorStore.md) + +## Constructors + +### constructor + +• **new SimpleVectorStore**(`data?`, `fs?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------- | +| `data?` | `SimpleVectorStoreData` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L37) + +## Properties + +### data + +• `Private` **data**: `SimpleVectorStoreData` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L33) + +--- + +### fs + +• `Private` **fs**: [`GenericFileSystem`](../interfaces/GenericFileSystem.md) = `DEFAULT_FS` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L34) + +--- + +### persistPath + +• `Private` **persistPath**: `undefined` \| `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L35) + +--- + +### storesText + +• **storesText**: `boolean` = `false` + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[storesText](../interfaces/VectorStore.md#storestext) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L32) + +## Accessors + +### client + +• `get` **client**(): `any` + +#### Returns + +`any` + +#### Implementation of + +VectorStore.client + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L50) + +## Methods + +### add + +▸ **add**(`embeddingResults`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------- | +| `embeddingResults` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`string`[]\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[add](../interfaces/VectorStore.md#add) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L58) + +--- + +### delete + +▸ **delete**(`refDocId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[delete](../interfaces/VectorStore.md#delete) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:77](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L77) + +--- + +### get + +▸ **get**(`textId`): `Promise`<`number`[]\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `textId` | `string` | + +#### Returns + +`Promise`<`number`[]\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L54) + +--- + +### persist + +▸ **persist**(`persistPath?`, `fs?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L146) + +--- + +### query + +▸ **query**(`query`): `Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------ | +| `query` | [`VectorStoreQuery`](../interfaces/VectorStoreQuery.md) | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md)\> + +#### Implementation of + +[VectorStore](../interfaces/VectorStore.md).[query](../interfaces/VectorStore.md#query) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L88) + +--- + +### toDict + +▸ **toDict**(): `SimpleVectorStoreData` + +#### Returns + +`SimpleVectorStoreData` + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:196](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L196) + +--- + +### fromDict + +▸ `Static` **fromDict**(`saveDict`): [`SimpleVectorStore`](SimpleVectorStore.md) + +#### Parameters + +| Name | Type | +| :--------- | :---------------------- | +| `saveDict` | `SimpleVectorStoreData` | + +#### Returns + +[`SimpleVectorStore`](SimpleVectorStore.md) + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:189](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L189) + +--- + +### fromPersistDir + +▸ `Static` **fromPersistDir**(`persistDir?`, `fs?`): `Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Parameters + +| Name | Type | Default value | +| :----------- | :-------------------------------------------------------- | :-------------------- | +| `persistDir` | `string` | `DEFAULT_PERSIST_DIR` | +| `fs` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | `DEFAULT_FS` | + +#### Returns + +`Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L42) + +--- + +### fromPersistPath + +▸ `Static` **fromPersistPath**(`persistPath`, `fs?`): `Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------------------- | +| `persistPath` | `string` | +| `fs?` | [`GenericFileSystem`](../interfaces/GenericFileSystem.md) | + +#### Returns + +`Promise`<[`SimpleVectorStore`](SimpleVectorStore.md)\> + +#### Defined in + +[packages/core/src/storage/vectorStore/SimpleVectorStore.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/SimpleVectorStore.ts#L159) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SubQuestionOutputParser.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SubQuestionOutputParser.md new file mode 100644 index 0000000000000000000000000000000000000000..81531cad5eda2fca177d5fe22c8bd3d1d311fa2c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SubQuestionOutputParser.md @@ -0,0 +1,67 @@ +--- +id: "SubQuestionOutputParser" +title: "Class: SubQuestionOutputParser" +sidebar_label: "SubQuestionOutputParser" +sidebar_position: 0 +custom_edit_url: null +--- + +SubQuestionOutputParser is used to parse the output of the SubQuestionGenerator. + +## Implements + +- [`BaseOutputParser`](../interfaces/BaseOutputParser.md)<[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\>\> + +## Constructors + +### constructor + +• **new SubQuestionOutputParser**() + +## Methods + +### format + +▸ **format**(`output`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +`string` + +#### Implementation of + +[BaseOutputParser](../interfaces/BaseOutputParser.md).[format](../interfaces/BaseOutputParser.md#format) + +#### Defined in + +[packages/core/src/OutputParser.ts:98](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L98) + +--- + +### parse + +▸ **parse**(`output`): [`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +[`StructuredOutput`](../interfaces/StructuredOutput.md)<[`SubQuestion`](../interfaces/SubQuestion.md)[]\> + +#### Implementation of + +[BaseOutputParser](../interfaces/BaseOutputParser.md).[parse](../interfaces/BaseOutputParser.md#parse) + +#### Defined in + +[packages/core/src/OutputParser.ts:90](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L90) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SubQuestionQueryEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SubQuestionQueryEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..ccede1ef01dde4a0c63a3efdfc53e44c51544745 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SubQuestionQueryEngine.md @@ -0,0 +1,143 @@ +--- +id: "SubQuestionQueryEngine" +title: "Class: SubQuestionQueryEngine" +sidebar_label: "SubQuestionQueryEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +SubQuestionQueryEngine decomposes a question into subquestions and then + +## Implements + +- [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +## Constructors + +### constructor + +• **new SubQuestionQueryEngine**(`init`) + +#### Parameters + +| Name | Type | +| :------------------------- | :---------------------------------------------------------------- | +| `init` | `Object` | +| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] | +| `init.questionGen` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) | +| `init.responseSynthesizer` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | + +#### Defined in + +[packages/core/src/QueryEngine.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L89) + +## Properties + +### metadatas + +• **metadatas**: [`ToolMetadata`](../interfaces/ToolMetadata.md)[] + +#### Defined in + +[packages/core/src/QueryEngine.ts:87](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L87) + +--- + +### queryEngines + +• **queryEngines**: `Record`<`string`, [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md)\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L86) + +--- + +### questionGen + +• **questionGen**: [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:85](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L85) + +--- + +### responseSynthesizer + +• **responseSynthesizer**: [`ResponseSynthesizer`](ResponseSynthesizer.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L84) + +## Methods + +### query + +▸ **query**(`query`): `Promise`<[`Response`](Response.md)\> + +Query the query engine and get a response. + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `query` | `string` | + +#### Returns + +`Promise`<[`Response`](Response.md)\> + +#### Implementation of + +[BaseQueryEngine](../interfaces/BaseQueryEngine.md).[query](../interfaces/BaseQueryEngine.md#query) + +#### Defined in + +[packages/core/src/QueryEngine.ts:130](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L130) + +--- + +### querySubQ + +▸ `Private` **querySubQ**(`subQ`, `parentEvent?`): `Promise`<`null` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------------------- | +| `subQ` | [`SubQuestion`](../interfaces/SubQuestion.md) | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`null` \| [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L158) + +--- + +### fromDefaults + +▸ `Static` **fromDefaults**(`init`): [`SubQuestionQueryEngine`](SubQuestionQueryEngine.md) + +#### Parameters + +| Name | Type | +| :-------------------------- | :---------------------------------------------------------------- | +| `init` | `Object` | +| `init.queryEngineTools` | [`QueryEngineTool`](../interfaces/QueryEngineTool.md)[] | +| `init.questionGen?` | [`BaseQuestionGenerator`](../interfaces/BaseQuestionGenerator.md) | +| `init.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | +| `init.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +[`SubQuestionQueryEngine`](SubQuestionQueryEngine.md) + +#### Defined in + +[packages/core/src/QueryEngine.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L106) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryChatHistory.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryChatHistory.md new file mode 100644 index 0000000000000000000000000000000000000000..89dd15e4971507fa9a3559227bd09a23adacd5a2 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryChatHistory.md @@ -0,0 +1,289 @@ +--- +id: "SummaryChatHistory" +title: "Class: SummaryChatHistory" +sidebar_label: "SummaryChatHistory" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatHistory is used to keep the state of back and forth chat messages + +## Implements + +- [`ChatHistory`](../interfaces/ChatHistory.md) + +## Constructors + +### constructor + +• **new SummaryChatHistory**(`init?`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------------------------------- | +| `init?` | `Partial`<[`SummaryChatHistory`](SummaryChatHistory.md)\> | + +#### Defined in + +[packages/core/src/ChatHistory.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L70) + +## Properties + +### llm + +• **llm**: [`LLM`](../interfaces/LLM.md) + +#### Defined in + +[packages/core/src/ChatHistory.ts:67](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L67) + +--- + +### messages + +• **messages**: [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[messages](../interfaces/ChatHistory.md#messages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L65) + +--- + +### messagesBefore + +• `Private` **messagesBefore**: `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L68) + +--- + +### summaryPrompt + +• **summaryPrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ChatHistory.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L66) + +--- + +### tokensToSummarize + +• **tokensToSummarize**: `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L64) + +## Accessors + +### nonSystemMessages + +• `Private` `get` **nonSystemMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L127) + +--- + +### systemMessages + +• `Private` `get` **systemMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:122](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L122) + +## Methods + +### addMessage + +▸ **addMessage**(`message`): `void` + +Adds a message to the chat history. + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------------------- | +| `message` | [`ChatMessage`](../interfaces/ChatMessage.md) | + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[addMessage](../interfaces/ChatHistory.md#addmessage) + +#### Defined in + +[packages/core/src/ChatHistory.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L106) + +--- + +### calcConversationMessages + +▸ `Private` **calcConversationMessages**(`transformSummary?`): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +Calculates the messages that describe the conversation so far. +If there's no memory, all non-system messages are used. +If there's a memory, uses all messages after the last summary message. + +#### Parameters + +| Name | Type | +| :------------------ | :-------- | +| `transformSummary?` | `boolean` | + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:137](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L137) + +--- + +### calcCurrentRequestMessages + +▸ `Private` **calcCurrentRequestMessages**(`transientMessages?`): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `transientMessages?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L155) + +--- + +### getLastSummaryIndex + +▸ `Private` **getLastSummaryIndex**(): `null` \| `number` + +#### Returns + +`null` \| `number` + +#### Defined in + +[packages/core/src/ChatHistory.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L111) + +--- + +### newMessages + +▸ **newMessages**(): [`ChatMessage`](../interfaces/ChatMessage.md)[] + +Returns the new messages since the last call to this function (or since calling the constructor) + +#### Returns + +[`ChatMessage`](../interfaces/ChatMessage.md)[] + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[newMessages](../interfaces/ChatHistory.md#newmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:195](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L195) + +--- + +### requestMessages + +▸ **requestMessages**(`transientMessages?`): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +Returns the messages that should be used as input to the LLM. + +#### Parameters + +| Name | Type | +| :------------------- | :---------------------------------------------- | +| `transientMessages?` | [`ChatMessage`](../interfaces/ChatMessage.md)[] | + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)[]\> + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[requestMessages](../interfaces/ChatHistory.md#requestmessages) + +#### Defined in + +[packages/core/src/ChatHistory.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L165) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Implementation of + +[ChatHistory](../interfaces/ChatHistory.md).[reset](../interfaces/ChatHistory.md#reset) + +#### Defined in + +[packages/core/src/ChatHistory.ts:191](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L191) + +--- + +### summarize + +▸ `Private` **summarize**(): `Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)\> + +#### Returns + +`Promise`<[`ChatMessage`](../interfaces/ChatMessage.md)\> + +#### Defined in + +[packages/core/src/ChatHistory.ts:84](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L84) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndex.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..0ba7ab01bfa763aa592d7b6d63955bcec98777ba --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndex.md @@ -0,0 +1,352 @@ +--- +id: "SummaryIndex" +title: "Class: SummaryIndex" +sidebar_label: "SummaryIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +A SummaryIndex keeps nodes in a sequential order for use with summarization. + +## Hierarchy + +- [`BaseIndex`](BaseIndex.md)<[`IndexList`](IndexList.md)\> + + ↳ **`SummaryIndex`** + +## Constructors + +### constructor + +• **new SummaryIndex**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :------------------------------------------------------------------------------ | +| `init` | [`BaseIndexInit`](../interfaces/BaseIndexInit.md)<[`IndexList`](IndexList.md)\> | + +#### Overrides + +[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L48) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:158](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L158) + +--- + +### indexStruct + +• **indexStruct**: [`IndexList`](IndexList.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L157) + +## Methods + +### asQueryEngine + +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | - | +| `options.preFilters?` | `unknown` | - | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L156) + +--- + +### asRetriever + +▸ **asRetriever**(`options?`): [`BaseRetriever`](../interfaces/BaseRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :------------- | :--------------------------------------------------------- | +| `options?` | `Object` | +| `options.mode` | [`SummaryRetrieverMode`](../enums/SummaryRetrieverMode.md) | + +#### Returns + +[`BaseRetriever`](../interfaces/BaseRetriever.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L143) + +--- + +### deleteNodes + +▸ **deleteNodes**(`nodeIds`, `deleteFromDocStore`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------------- | :--------- | +| `nodeIds` | `string`[] | +| `deleteFromDocStore` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L224) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :-------------------- | :-------- | +| `refDocId` | `string` | +| `deleteFromDocStore?` | `boolean` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:205](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L205) + +--- + +### getRefDocInfo + +▸ **getRefDocInfo**(): `Promise`<`Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Returns + +`Promise`<`Record`<`string`, [`RefDocInfo`](../interfaces/RefDocInfo.md)\>\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:238](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L238) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:199](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L199) + +--- + +### buildIndexFromNodes + +▸ `Static` **buildIndexFromNodes**(`nodes`, `docStore`, `indexStruct?`): `Promise`<[`IndexList`](IndexList.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | +| `docStore` | [`BaseDocumentStore`](BaseDocumentStore.md) | +| `indexStruct?` | [`IndexList`](IndexList.md) | + +#### Returns + +`Promise`<[`IndexList`](IndexList.md)\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:184](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L184) + +--- + +### fromDocuments + +▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Parameters + +| Name | Type | +| :--------------------- | :------------------------------------------------------- | +| `documents` | [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] | +| `args` | `Object` | +| `args.serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `args.storageContext?` | [`StorageContext`](../interfaces/StorageContext.md) | + +#### Returns + +`Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:117](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L117) + +--- + +### init + +▸ `Static` **init**(`options`): `Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Parameters + +| Name | Type | +| :-------- | :-------------------- | +| `options` | `SummaryIndexOptions` | + +#### Returns + +`Promise`<[`SummaryIndex`](SummaryIndex.md)\> + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L52) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexLLMRetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexLLMRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..cf0862b745f492b3e37bba041b94dab5414dcca0 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexLLMRetriever.md @@ -0,0 +1,151 @@ +--- +id: "SummaryIndexLLMRetriever" +title: "Class: SummaryIndexLLMRetriever" +sidebar_label: "SummaryIndexLLMRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +LLM retriever for SummaryIndex which lets you select the most relevant chunks. + +## Implements + +- [`BaseRetriever`](../interfaces/BaseRetriever.md) + +## Constructors + +### constructor + +• **new SummaryIndexLLMRetriever**(`index`, `choiceSelectPrompt?`, `choiceBatchSize?`, `formatNodeBatchFn?`, `parseChoiceSelectAnswerFn?`, `serviceContext?`) + +#### Parameters + +| Name | Type | Default value | +| :--------------------------- | :-------------------------------------------------- | :------------ | +| `index` | [`SummaryIndex`](SummaryIndex.md) | `undefined` | +| `choiceSelectPrompt?` | (`__namedParameters`: `Object`) => `string` | `undefined` | +| `choiceBatchSize` | `number` | `10` | +| `formatNodeBatchFn?` | `NodeFormatterFunction` | `undefined` | +| `parseChoiceSelectAnswerFn?` | `ChoiceSelectParserFunction` | `undefined` | +| `serviceContext?` | [`ServiceContext`](../interfaces/ServiceContext.md) | `undefined` | + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L64) + +## Properties + +### choiceBatchSize + +• **choiceBatchSize**: `number` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L59) + +--- + +### choiceSelectPrompt + +• **choiceSelectPrompt**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L58) + +--- + +### formatNodeBatchFn + +• **formatNodeBatchFn**: `NodeFormatterFunction` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L60) + +--- + +### index + +• **index**: [`SummaryIndex`](SummaryIndex.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L57) + +--- + +### parseChoiceSelectAnswerFn + +• **parseChoiceSelectAnswerFn**: `ChoiceSelectParserFunction` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L61) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L62) + +## Methods + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:127](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L127) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:81](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L81) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexRetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..599a0db8f6f260fac92e4975bfd5e1bd428e0875 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/SummaryIndexRetriever.md @@ -0,0 +1,82 @@ +--- +id: "SummaryIndexRetriever" +title: "Class: SummaryIndexRetriever" +sidebar_label: "SummaryIndexRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +Simple retriever for SummaryIndex that returns all nodes + +## Implements + +- [`BaseRetriever`](../interfaces/BaseRetriever.md) + +## Constructors + +### constructor + +• **new SummaryIndexRetriever**(`index`) + +#### Parameters + +| Name | Type | +| :------ | :-------------------------------- | +| `index` | [`SummaryIndex`](SummaryIndex.md) | + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L22) + +## Properties + +### index + +• **index**: [`SummaryIndex`](SummaryIndex.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L20) + +## Methods + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L48) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L26) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TextFileReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TextFileReader.md new file mode 100644 index 0000000000000000000000000000000000000000..d66aee67ec4ad9d6e2480175202d87e1d67153c4 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TextFileReader.md @@ -0,0 +1,44 @@ +--- +id: "TextFileReader" +title: "Class: TextFileReader" +sidebar_label: "TextFileReader" +sidebar_position: 0 +custom_edit_url: null +--- + +Read a .txt file + +## Implements + +- [`BaseReader`](../interfaces/BaseReader.md) + +## Constructors + +### constructor + +• **new TextFileReader**() + +## Methods + +### loadData + +▸ **loadData**(`file`, `fs?`): `Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :----- | :--------------------------------------------- | +| `file` | `string` | +| `fs` | [`CompleteFileSystem`](../#completefilesystem) | + +#### Returns + +`Promise`<[`Document`](Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseReader](../interfaces/BaseReader.md).[loadData](../interfaces/BaseReader.md#loaddata) + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L29) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TextNode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TextNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1f66d83a63ba7436b3d7bab857d5829d1199f78e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TextNode.md @@ -0,0 +1,486 @@ +--- +id: "TextNode" +title: "Class: TextNode<T>" +sidebar_label: "TextNode" +sidebar_position: 0 +custom_edit_url: null +--- + +TextNode is the default node type for text. Most common node type in LlamaIndex.TS + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Hierarchy + +- [`BaseNode`](BaseNode.md)<`T`\> + + ↳ **`TextNode`** + + ↳↳ [`IndexNode`](IndexNode.md) + + ↳↳ [`Document`](Document.md) + + ↳↳ [`ImageNode`](ImageNode.md) + +## Constructors + +### constructor + +• **new TextNode**<`T`\>(`init?`) + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------ | +| `init?` | `Partial`<[`TextNode`](TextNode.md)<`T`\>\> | + +#### Overrides + +[BaseNode](BaseNode.md).[constructor](BaseNode.md#constructor) + +#### Defined in + +[packages/core/src/Node.ts:162](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L162) + +## Properties + +### embedding + +• `Optional` **embedding**: `number`[] + +#### Inherited from + +[BaseNode](BaseNode.md).[embedding](BaseNode.md#embedding) + +#### Defined in + +[packages/core/src/Node.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L51) + +--- + +### endCharIdx + +• `Optional` **endCharIdx**: `number` + +#### Defined in + +[packages/core/src/Node.ts:157](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L157) + +--- + +### excludedEmbedMetadataKeys + +• **excludedEmbedMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[BaseNode](BaseNode.md).[excludedEmbedMetadataKeys](BaseNode.md#excludedembedmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L55) + +--- + +### excludedLlmMetadataKeys + +• **excludedLlmMetadataKeys**: `string`[] = `[]` + +#### Inherited from + +[BaseNode](BaseNode.md).[excludedLlmMetadataKeys](BaseNode.md#excludedllmmetadatakeys) + +#### Defined in + +[packages/core/src/Node.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L56) + +--- + +### hash + +• **hash**: `string` = `""` + +#### Inherited from + +[BaseNode](BaseNode.md).[hash](BaseNode.md#hash) + +#### Defined in + +[packages/core/src/Node.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L58) + +--- + +### id\_ + +• **id\_**: `string` + +The unique ID of the Node/Document. The trailing underscore is here +to avoid collisions with the id keyword in Python. + +Set to a UUID by default. + +#### Inherited from + +[BaseNode](BaseNode.md).[id\_](BaseNode.md#id_) + +#### Defined in + +[packages/core/src/Node.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L50) + +--- + +### metadata + +• **metadata**: `T` + +#### Inherited from + +[BaseNode](BaseNode.md).[metadata](BaseNode.md#metadata) + +#### Defined in + +[packages/core/src/Node.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L54) + +--- + +### metadataSeparator + +• **metadataSeparator**: `string` = `"\n"` + +#### Defined in + +[packages/core/src/Node.ts:160](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L160) + +--- + +### relationships + +• **relationships**: `Partial`<`Record`<[`NodeRelationship`](../enums/NodeRelationship.md), [`RelatedNodeType`](../#relatednodetype)<`T`\>\>\> = `{}` + +#### Inherited from + +[BaseNode](BaseNode.md).[relationships](BaseNode.md#relationships) + +#### Defined in + +[packages/core/src/Node.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L57) + +--- + +### startCharIdx + +• `Optional` **startCharIdx**: `number` + +#### Defined in + +[packages/core/src/Node.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L156) + +--- + +### text + +• **text**: `string` = `""` + +#### Defined in + +[packages/core/src/Node.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L155) + +## Accessors + +### childNodes + +• `get` **childNodes**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Inherited from + +BaseNode.childNodes + +#### Defined in + +[packages/core/src/Node.ts:112](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L112) + +--- + +### nextNode + +• `get` **nextNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.nextNode + +#### Defined in + +[packages/core/src/Node.ts:92](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L92) + +--- + +### parentNode + +• `get` **parentNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.parentNode + +#### Defined in + +[packages/core/src/Node.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L102) + +--- + +### prevNode + +• `get` **prevNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.prevNode + +#### Defined in + +[packages/core/src/Node.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L80) + +--- + +### sourceNode + +• `get` **sourceNode**(): `undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +`undefined` \| [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +BaseNode.sourceNode + +#### Defined in + +[packages/core/src/Node.ts:70](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L70) + +## Methods + +### asRelatedNodeInfo + +▸ **asRelatedNodeInfo**(): [`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Returns + +[`RelatedNodeInfo`](../interfaces/RelatedNodeInfo.md)<`T`\> + +#### Inherited from + +[BaseNode](BaseNode.md).[asRelatedNodeInfo](BaseNode.md#asrelatednodeinfo) + +#### Defined in + +[packages/core/src/Node.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L134) + +--- + +### generateHash + +▸ **generateHash**(): `string` + +Generate a hash of the text node. +The ID is not part of the hash as it can change independent of content. + +#### Returns + +`string` + +#### Overrides + +[BaseNode](BaseNode.md).[generateHash](BaseNode.md#generatehash) + +#### Defined in + +[packages/core/src/Node.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L178) + +--- + +### getContent + +▸ **getContent**(`metadataMode?`): `string` + +#### Parameters + +| Name | Type | Default value | +| :------------- | :----------------------------------------- | :------------------ | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | `MetadataMode.NONE` | + +#### Returns + +`string` + +#### Overrides + +[BaseNode](BaseNode.md).[getContent](BaseNode.md#getcontent) + +#### Defined in + +[packages/core/src/Node.ts:192](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L192) + +--- + +### getEmbedding + +▸ **getEmbedding**(): `number`[] + +#### Returns + +`number`[] + +#### Inherited from + +[BaseNode](BaseNode.md).[getEmbedding](BaseNode.md#getembedding) + +#### Defined in + +[packages/core/src/Node.ts:126](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L126) + +--- + +### getMetadataStr + +▸ **getMetadataStr**(`metadataMode`): `string` + +#### Parameters + +| Name | Type | +| :------------- | :----------------------------------------- | +| `metadataMode` | [`MetadataMode`](../enums/MetadataMode.md) | + +#### Returns + +`string` + +#### Overrides + +[BaseNode](BaseNode.md).[getMetadataStr](BaseNode.md#getmetadatastr) + +#### Defined in + +[packages/core/src/Node.ts:197](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L197) + +--- + +### getNodeInfo + +▸ **getNodeInfo**(): `Object` + +#### Returns + +`Object` + +| Name | Type | +| :------ | :---------------------- | +| `end` | `undefined` \| `number` | +| `start` | `undefined` \| `number` | + +#### Defined in + +[packages/core/src/Node.ts:224](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L224) + +--- + +### getText + +▸ **getText**(): `string` + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Node.ts:228](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L228) + +--- + +### getType + +▸ **getType**(): [`ObjectType`](../enums/ObjectType.md) + +#### Returns + +[`ObjectType`](../enums/ObjectType.md) + +#### Overrides + +[BaseNode](BaseNode.md).[getType](BaseNode.md#gettype) + +#### Defined in + +[packages/core/src/Node.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L188) + +--- + +### setContent + +▸ **setContent**(`value`): `void` + +#### Parameters + +| Name | Type | +| :------ | :------- | +| `value` | `string` | + +#### Returns + +`void` + +#### Overrides + +[BaseNode](BaseNode.md).[setContent](BaseNode.md#setcontent) + +#### Defined in + +[packages/core/src/Node.ts:218](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L218) + +--- + +### toJSON + +▸ **toJSON**(): `Record`<`string`, `any`\> + +Used with built in JSON.stringify + +#### Returns + +`Record`<`string`, `any`\> + +#### Inherited from + +[BaseNode](BaseNode.md).[toJSON](BaseNode.md#tojson) + +#### Defined in + +[packages/core/src/Node.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L146) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TreeSummarize.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TreeSummarize.md new file mode 100644 index 0000000000000000000000000000000000000000..725f514fca97bca852ea3e2c232ee319e05c3f09 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/TreeSummarize.md @@ -0,0 +1,90 @@ +--- +id: "TreeSummarize" +title: "Class: TreeSummarize" +sidebar_label: "TreeSummarize" +sidebar_position: 0 +custom_edit_url: null +--- + +TreeSummarize repacks the text chunks into the smallest possible number of chunks and then summarizes them, then recursively does so until there's one chunk left. + +## Implements + +- `BaseResponseBuilder` + +## Constructors + +### constructor + +• **new TreeSummarize**(`serviceContext`, `summaryTemplate?`) + +#### Parameters + +| Name | Type | +| :----------------- | :-------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | +| `summaryTemplate?` | (`__namedParameters`: `Object`) => `string` | + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:217](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L217) + +## Properties + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:214](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L214) + +--- + +### summaryTemplate + +• **summaryTemplate**: (`__namedParameters`: `Object`) => `string` + +#### Type declaration + +▸ (`«destructured»`): `string` + +##### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:215](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L215) + +## Methods + +### getResponse + +▸ **getResponse**(`query`, `textChunks`, `parentEvent?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `textChunks` | `string`[] | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | + +#### Returns + +`Promise`<`string`\> + +#### Implementation of + +BaseResponseBuilder.getResponse + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:225](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L225) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/VectorIndexRetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/VectorIndexRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..492154f4c7852a34bd872938f7c3b54d1b7b421d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/VectorIndexRetriever.md @@ -0,0 +1,210 @@ +--- +id: "VectorIndexRetriever" +title: "Class: VectorIndexRetriever" +sidebar_label: "VectorIndexRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +VectorIndexRetriever retrieves nodes from a VectorIndex. + +## Implements + +- [`BaseRetriever`](../interfaces/BaseRetriever.md) + +## Constructors + +### constructor + +• **new VectorIndexRetriever**(`«destructured»`) + +#### Parameters + +| Name | Type | +| :------------------ | :---------------------------------------- | +| `«destructured»` | `Object` | +| › `index` | [`VectorStoreIndex`](VectorStoreIndex.md) | +| › `similarityTopK?` | `number` | + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L24) + +## Properties + +### index + +• **index**: [`VectorStoreIndex`](VectorStoreIndex.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L20) + +--- + +### serviceContext + +• `Private` **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L22) + +--- + +### similarityTopK + +• **similarityTopK**: `number` + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L21) + +## Methods + +### buildNodeListFromQueryResult + +▸ `Protected` **buildNodeListFromQueryResult**(`result`): [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Parameters + +| Name | Type | +| :------- | :------------------------------------------------------------------ | +| `result` | [`VectorStoreQueryResult`](../interfaces/VectorStoreQueryResult.md) | + +#### Returns + +[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:102](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L102) + +--- + +### buildVectorStoreQuery + +▸ `Protected` **buildVectorStoreQuery**(`embedModel`, `query`): `Promise`<[`VectorStoreQuery`](../interfaces/VectorStoreQuery.md)\> + +#### Parameters + +| Name | Type | +| :----------- | :---------------------------------- | +| `embedModel` | [`BaseEmbedding`](BaseEmbedding.md) | +| `query` | `string` | + +#### Returns + +`Promise`<[`VectorStoreQuery`](../interfaces/VectorStoreQuery.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:89](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L89) + +--- + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Returns + +[`ServiceContext`](../interfaces/ServiceContext.md) + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[getServiceContext](../interfaces/BaseRetriever.md#getservicecontext) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:120](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L120) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`, `preFilters?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :-------------------------------- | +| `query` | `string` | +| `parentEvent?` | [`Event`](../interfaces/Event.md) | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Implementation of + +[BaseRetriever](../interfaces/BaseRetriever.md).[retrieve](../interfaces/BaseRetriever.md#retrieve) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L37) + +--- + +### sendEvent + +▸ `Protected` **sendEvent**(`query`, `nodesWithScores`, `parentEvent`): `void` + +#### Parameters + +| Name | Type | +| :---------------- | :------------------------------------------------------------------------------- | +| `query` | `string` | +| `nodesWithScores` | [`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | +| `parentEvent` | `undefined` \| [`Event`](../interfaces/Event.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:72](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L72) + +--- + +### textRetrieve + +▸ `Protected` **textRetrieve**(`query`, `preFilters?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------- | +| `query` | `string` | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L50) + +--- + +### textToImageRetrieve + +▸ `Private` **textToImageRetrieve**(`query`, `preFilters?`): `Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------ | :-------- | +| `query` | `string` | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](../interfaces/NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorIndexRetriever.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorIndexRetriever.ts#L59) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/VectorStoreIndex.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/VectorStoreIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..34fef11cc8d56827b7aa4bb066321d362e75610d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/VectorStoreIndex.md @@ -0,0 +1,503 @@ +--- +id: "VectorStoreIndex" +title: "Class: VectorStoreIndex" +sidebar_label: "VectorStoreIndex" +sidebar_position: 0 +custom_edit_url: null +--- + +The VectorStoreIndex, an index that stores the nodes only according to their vector embedings. + +## Hierarchy + +- [`BaseIndex`](BaseIndex.md)<[`IndexDict`](IndexDict.md)\> + + ↳ **`VectorStoreIndex`** + +## Constructors + +### constructor + +• `Private` **new VectorStoreIndex**(`init`) + +#### Parameters + +| Name | Type | +| :----- | :---------------------------- | +| `init` | `VectorIndexConstructorProps` | + +#### Overrides + +[BaseIndex](BaseIndex.md).[constructor](BaseIndex.md#constructor) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L64) + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](BaseDocumentStore.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[docStore](BaseIndex.md#docstore) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:156](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L156) + +--- + +### embedModel + +• **embedModel**: [`BaseEmbedding`](BaseEmbedding.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L60) + +--- + +### imageEmbedModel + +• `Optional` **imageEmbedModel**: [`MultiModalEmbedding`](MultiModalEmbedding.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L62) + +--- + +### imageVectorStore + +• `Optional` **imageVectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L61) + +--- + +### indexStore + +• **indexStore**: [`BaseIndexStore`](BaseIndexStore.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[indexStore](BaseIndex.md#indexstore) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L59) + +--- + +### indexStruct + +• **indexStruct**: [`IndexDict`](IndexDict.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[indexStruct](BaseIndex.md#indexstruct) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:159](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L159) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](../interfaces/ServiceContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[serviceContext](BaseIndex.md#servicecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:154](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L154) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](../interfaces/StorageContext.md) + +#### Inherited from + +[BaseIndex](BaseIndex.md).[storageContext](BaseIndex.md#storagecontext) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L155) + +--- + +### vectorStore + +• **vectorStore**: [`VectorStore`](../interfaces/VectorStore.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[vectorStore](BaseIndex.md#vectorstore) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L58) + +## Methods + +### asQueryEngine + +▸ **asQueryEngine**(`options?`): [`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +Create a new query engine from the index. It will also create a retriever +and response synthezier if they are not provided. + +#### Parameters + +| Name | Type | Description | +| :----------------------------- | :------------------------------------------------------------------ | :--------------------------------------------------------------- | +| `options?` | `Object` | you can supply your own custom Retriever and ResponseSynthesizer | +| `options.nodePostprocessors?` | [`BaseNodePostprocessor`](../interfaces/BaseNodePostprocessor.md)[] | - | +| `options.preFilters?` | `unknown` | - | +| `options.responseSynthesizer?` | [`ResponseSynthesizer`](ResponseSynthesizer.md) | - | +| `options.retriever?` | [`BaseRetriever`](../interfaces/BaseRetriever.md) | - | + +#### Returns + +[`BaseQueryEngine`](../interfaces/BaseQueryEngine.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asQueryEngine](BaseIndex.md#asqueryengine) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:244](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L244) + +--- + +### asRetriever + +▸ **asRetriever**(`options?`): [`VectorIndexRetriever`](VectorIndexRetriever.md) + +Create a new retriever from the index. + +#### Parameters + +| Name | Type | +| :--------- | :---- | +| `options?` | `any` | + +#### Returns + +[`VectorIndexRetriever`](VectorIndexRetriever.md) + +#### Overrides + +[BaseIndex](BaseIndex.md).[asRetriever](BaseIndex.md#asretriever) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:240](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L240) + +--- + +### buildIndexFromNodes + +▸ **buildIndexFromNodes**(`nodes`): `Promise`<`void`\> + +Get embeddings for nodes and place them into the index. + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:178](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L178) + +--- + +### deleteRefDoc + +▸ **deleteRefDoc**(`refDocId`, `deleteFromDocStore?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------------------- | :-------- | :------------ | +| `refDocId` | `string` | `undefined` | +| `deleteFromDocStore` | `boolean` | `true` | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[deleteRefDoc](BaseIndex.md#deleterefdoc) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:305](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L305) + +--- + +### deleteRefDocFromStore + +▸ `Protected` **deleteRefDocFromStore**(`vectorStore`, `refDocId`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :-------------------------------------------- | +| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) | +| `refDocId` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:319](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L319) + +--- + +### getImageNodeEmbeddingResults + +▸ **getImageNodeEmbeddingResults**(`nodes`, `logProgress?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +Get the embeddings for image nodes. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :--------------------------------------------------------- | :------------ | :--------------------------------------------- | +| `nodes` | [`ImageNode`](ImageNode.md)<[`Metadata`](../#metadata)\>[] | `undefined` | | +| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:345](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L345) + +--- + +### getNodeEmbeddingResults + +▸ **getNodeEmbeddingResults**(`nodes`, `logProgress?`): `Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +Get the embeddings for nodes. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------ | :------------------------------------------------------- | :------------ | :--------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | `undefined` | | +| `logProgress` | `boolean` | `false` | log progress to console (useful for debugging) | + +#### Returns + +`Promise`<[`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:155](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L155) + +--- + +### insert + +▸ **insert**(`document`): `Promise`<`void`\> + +Insert a document into the index. + +#### Parameters + +| Name | Type | +| :--------- | :----------------------------------------------------- | +| `document` | [`Document`](Document.md)<[`Metadata`](../#metadata)\> | + +#### Returns + +`Promise`<`void`\> + +#### Inherited from + +[BaseIndex](BaseIndex.md).[insert](BaseIndex.md#insert) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:190](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L190) + +--- + +### insertNodes + +▸ **insertNodes**(`nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Overrides + +[BaseIndex](BaseIndex.md).[insertNodes](BaseIndex.md#insertnodes) + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:284](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L284) + +--- + +### insertNodesToStore + +▸ `Protected` **insertNodesToStore**(`vectorStore`, `nodes`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :------------ | :------------------------------------------------------- | +| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:259](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L259) + +--- + +### splitNodes + +▸ `Private` **splitNodes**(`nodes`): `Object` + +#### Parameters + +| Name | Type | +| :------ | :------------------------------------------------------- | +| `nodes` | [`BaseNode`](BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Object` + +| Name | Type | +| :----------- | :--------------------------------------------------------- | +| `imageNodes` | [`ImageNode`](ImageNode.md)<[`Metadata`](../#metadata)\>[] | +| `textNodes` | [`TextNode`](TextNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:367](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L367) + +--- + +### fromDocuments + +▸ `Static` **fromDocuments**(`documents`, `args?`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +High level API: split documents, get embeddings, and build index. + +#### Parameters + +| Name | Type | +| :---------- | :------------------------------------------------------- | +| `documents` | [`Document`](Document.md)<[`Metadata`](../#metadata)\>[] | +| `args` | `VectorIndexOptions` | + +#### Returns + +`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:201](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L201) + +--- + +### fromVectorStore + +▸ `Static` **fromVectorStore**(`vectorStore`, `serviceContext`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------------------------------------------- | +| `vectorStore` | [`VectorStore`](../interfaces/VectorStore.md) | +| `serviceContext` | [`ServiceContext`](../interfaces/ServiceContext.md) | + +#### Returns + +`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:219](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L219) + +--- + +### init + +▸ `Static` **init**(`options`): `Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +The async init function creates a new VectorStoreIndex. + +#### Parameters + +| Name | Type | +| :-------- | :------------------- | +| `options` | `VectorIndexOptions` | + +#### Returns + +`Promise`<[`VectorStoreIndex`](VectorStoreIndex.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:80](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L80) + +--- + +### setupIndexStructFromStorage + +▸ `Static` `Private` **setupIndexStructFromStorage**(`indexStore`, `options`): `Promise`<`undefined` \| [`IndexDict`](IndexDict.md)\> + +#### Parameters + +| Name | Type | +| :----------- | :------------------------------------ | +| `indexStore` | [`BaseIndexStore`](BaseIndexStore.md) | +| `options` | `IndexStructOptions` | + +#### Returns + +`Promise`<`undefined` \| [`IndexDict`](IndexDict.md)\> + +#### Defined in + +[packages/core/src/indices/vectorStore/VectorStoreIndex.ts:118](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/vectorStore/VectorStoreIndex.ts#L118) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..55c7980a46440f2ff50537c3392125668d3bb43e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/classes/_category_.yml @@ -0,0 +1,2 @@ +label: "Classes" +position: 3 \ No newline at end of file diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/ClipEmbeddingModelType.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/ClipEmbeddingModelType.md new file mode 100644 index 0000000000000000000000000000000000000000..35d1b404d7fae42e592ed76c41ba7f43e172d976 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/ClipEmbeddingModelType.md @@ -0,0 +1,27 @@ +--- +id: "ClipEmbeddingModelType" +title: "Enumeration: ClipEmbeddingModelType" +sidebar_label: "ClipEmbeddingModelType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### XENOVA_CLIP_VIT_BASE_PATCH16 + +• **XENOVA_CLIP_VIT_BASE_PATCH16** = `"Xenova/clip-vit-base-patch16"` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L7) + +--- + +### XENOVA_CLIP_VIT_BASE_PATCH32 + +• **XENOVA_CLIP_VIT_BASE_PATCH32** = `"Xenova/clip-vit-base-patch32"` + +#### Defined in + +[packages/core/src/embeddings/ClipEmbedding.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/ClipEmbedding.ts#L6) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/DeuceChatStrategy.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/DeuceChatStrategy.md new file mode 100644 index 0000000000000000000000000000000000000000..616723a1d7fd172ccca3550e6b6abc1aefea2f89 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/DeuceChatStrategy.md @@ -0,0 +1,57 @@ +--- +id: "DeuceChatStrategy" +title: "Enumeration: DeuceChatStrategy" +sidebar_label: "DeuceChatStrategy" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### A16Z + +• **A16Z** = `"a16z"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:411](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L411) + +--- + +### META + +• **META** = `"meta"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:412](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L412) + +--- + +### METAWBOS + +• **METAWBOS** = `"metawbos"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:413](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L413) + +--- + +### REPLICATE4BIT + +• **REPLICATE4BIT** = `"replicate4bit"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:416](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L416) + +--- + +### REPLICATE4BITWNEWLINES + +• **REPLICATE4BITWNEWLINES** = `"replicate4bitwnewlines"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:418](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L418) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/IndexStructType.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/IndexStructType.md new file mode 100644 index 0000000000000000000000000000000000000000..dd4e4130cbd1c72f8f3d74c884429037ee6ced72 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/IndexStructType.md @@ -0,0 +1,37 @@ +--- +id: "IndexStructType" +title: "Enumeration: IndexStructType" +sidebar_label: "IndexStructType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### KEYWORD_TABLE + +• **KEYWORD_TABLE** = `"keyword_table"` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L42) + +--- + +### LIST + +• **LIST** = `"list"` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L41) + +--- + +### SIMPLE_DICT + +• **SIMPLE_DICT** = `"simple_dict"` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L40) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/KeywordTableRetrieverMode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/KeywordTableRetrieverMode.md new file mode 100644 index 0000000000000000000000000000000000000000..4e7a79b91d8f3c917d555f2d838523e9b92d0729 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/KeywordTableRetrieverMode.md @@ -0,0 +1,37 @@ +--- +id: "KeywordTableRetrieverMode" +title: "Enumeration: KeywordTableRetrieverMode" +sidebar_label: "KeywordTableRetrieverMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"DEFAULT"` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L34) + +--- + +### RAKE + +• **RAKE** = `"RAKE"` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L36) + +--- + +### SIMPLE + +• **SIMPLE** = `"SIMPLE"` + +#### Defined in + +[packages/core/src/indices/keyword/KeywordTableIndex.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/keyword/KeywordTableIndex.ts#L35) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/MetadataMode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/MetadataMode.md new file mode 100644 index 0000000000000000000000000000000000000000..95e1f3d81e7e6e573f07569dc3540f0a01a7ad05 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/MetadataMode.md @@ -0,0 +1,47 @@ +--- +id: "MetadataMode" +title: "Enumeration: MetadataMode" +sidebar_label: "MetadataMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### ALL + +• **ALL** = `"ALL"` + +#### Defined in + +[packages/core/src/Node.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L21) + +--- + +### EMBED + +• **EMBED** = `"EMBED"` + +#### Defined in + +[packages/core/src/Node.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L22) + +--- + +### LLM + +• **LLM** = `"LLM"` + +#### Defined in + +[packages/core/src/Node.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L23) + +--- + +### NONE + +• **NONE** = `"NONE"` + +#### Defined in + +[packages/core/src/Node.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L24) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/NodeRelationship.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/NodeRelationship.md new file mode 100644 index 0000000000000000000000000000000000000000..7f53d7e5fa8ca181b44500e503ff8a2526128e00 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/NodeRelationship.md @@ -0,0 +1,57 @@ +--- +id: "NodeRelationship" +title: "Enumeration: NodeRelationship" +sidebar_label: "NodeRelationship" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### CHILD + +• **CHILD** = `"CHILD"` + +#### Defined in + +[packages/core/src/Node.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L9) + +--- + +### NEXT + +• **NEXT** = `"NEXT"` + +#### Defined in + +[packages/core/src/Node.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L7) + +--- + +### PARENT + +• **PARENT** = `"PARENT"` + +#### Defined in + +[packages/core/src/Node.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L8) + +--- + +### PREVIOUS + +• **PREVIOUS** = `"PREVIOUS"` + +#### Defined in + +[packages/core/src/Node.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L6) + +--- + +### SOURCE + +• **SOURCE** = `"SOURCE"` + +#### Defined in + +[packages/core/src/Node.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L5) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/ObjectType.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/ObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..3b4626e6524f6d53661af3326507e86d014d329e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/ObjectType.md @@ -0,0 +1,57 @@ +--- +id: "ObjectType" +title: "Enumeration: ObjectType" +sidebar_label: "ObjectType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DOCUMENT + +• **DOCUMENT** = `"DOCUMENT"` + +#### Defined in + +[packages/core/src/Node.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L16) + +--- + +### IMAGE + +• **IMAGE** = `"IMAGE"` + +#### Defined in + +[packages/core/src/Node.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L14) + +--- + +### IMAGE_DOCUMENT + +• **IMAGE_DOCUMENT** = `"IMAGE_DOCUMENT"` + +#### Defined in + +[packages/core/src/Node.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L17) + +--- + +### INDEX + +• **INDEX** = `"INDEX"` + +#### Defined in + +[packages/core/src/Node.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L15) + +--- + +### TEXT + +• **TEXT** = `"TEXT"` + +#### Defined in + +[packages/core/src/Node.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L13) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/OpenAIEmbeddingModelType.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/OpenAIEmbeddingModelType.md new file mode 100644 index 0000000000000000000000000000000000000000..47c48e8490ab2bd48893f29fdc329491ead63777 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/OpenAIEmbeddingModelType.md @@ -0,0 +1,17 @@ +--- +id: "OpenAIEmbeddingModelType" +title: "Enumeration: OpenAIEmbeddingModelType" +sidebar_label: "OpenAIEmbeddingModelType" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### TEXT_EMBED_ADA_002 + +• **TEXT_EMBED_ADA_002** = `"text-embedding-ada-002"` + +#### Defined in + +[packages/core/src/embeddings/OpenAIEmbedding.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/OpenAIEmbedding.ts#L13) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/SimilarityType.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/SimilarityType.md new file mode 100644 index 0000000000000000000000000000000000000000..f3de64ef0eccab619e1de239a3afbc9cc2c08da8 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/SimilarityType.md @@ -0,0 +1,40 @@ +--- +id: "SimilarityType" +title: "Enumeration: SimilarityType" +sidebar_label: "SimilarityType" +sidebar_position: 0 +custom_edit_url: null +--- + +Similarity type +Default is cosine similarity. Dot product and negative Euclidean distance are also supported. + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"cosine"` + +#### Defined in + +[packages/core/src/embeddings/types.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L8) + +--- + +### DOT_PRODUCT + +• **DOT_PRODUCT** = `"dot_product"` + +#### Defined in + +[packages/core/src/embeddings/types.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L9) + +--- + +### EUCLIDEAN + +• **EUCLIDEAN** = `"euclidean"` + +#### Defined in + +[packages/core/src/embeddings/types.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/types.ts#L10) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/SummaryRetrieverMode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/SummaryRetrieverMode.md new file mode 100644 index 0000000000000000000000000000000000000000..272ab05d4f934725c0bc8df5a3b83c3a7491e29e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/SummaryRetrieverMode.md @@ -0,0 +1,27 @@ +--- +id: "SummaryRetrieverMode" +title: "Enumeration: SummaryRetrieverMode" +sidebar_label: "SummaryRetrieverMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"default"` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L31) + +--- + +### LLM + +• **LLM** = `"llm"` + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L33) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/Tokenizers.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/Tokenizers.md new file mode 100644 index 0000000000000000000000000000000000000000..690dc82f5bd78b4308155f2674064f6ec3065acb --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/Tokenizers.md @@ -0,0 +1,17 @@ +--- +id: "Tokenizers" +title: "Enumeration: Tokenizers" +sidebar_label: "Tokenizers" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### CL100K_BASE + +• **CL100K_BASE** = `"cl100k_base"` + +#### Defined in + +[packages/core/src/GlobalsHelper.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/GlobalsHelper.ts#L7) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/VectorStoreQueryMode.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/VectorStoreQueryMode.md new file mode 100644 index 0000000000000000000000000000000000000000..0e4de201ecdc4db086703f7f4d1d916412caf20a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/VectorStoreQueryMode.md @@ -0,0 +1,77 @@ +--- +id: "VectorStoreQueryMode" +title: "Enumeration: VectorStoreQueryMode" +sidebar_label: "VectorStoreQueryMode" +sidebar_position: 0 +custom_edit_url: null +--- + +## Enumeration Members + +### DEFAULT + +• **DEFAULT** = `"default"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L10) + +--- + +### HYBRID + +• **HYBRID** = `"hybrid"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L12) + +--- + +### LINEAR_REGRESSION + +• **LINEAR_REGRESSION** = `"linear_regression"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L16) + +--- + +### LOGISTIC_REGRESSION + +• **LOGISTIC_REGRESSION** = `"logistic_regression"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L15) + +--- + +### MMR + +• **MMR** = `"mmr"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L18) + +--- + +### SPARSE + +• **SPARSE** = `"sparse"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L11) + +--- + +### SVM + +• **SVM** = `"svm"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..1687a9e03fd705b092a975c2bd86f8e76af69ea1 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/enums/_category_.yml @@ -0,0 +1,2 @@ +label: "Enumerations" +position: 2 \ No newline at end of file diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/index.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/index.md new file mode 100644 index 0000000000000000000000000000000000000000..b367cb1f9fd0ad38fe10b61d51a6dcfe248e3936 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/index.md @@ -0,0 +1,1553 @@ +--- +id: "index" +title: "llamaindex" +sidebar_label: "Exports" +sidebar_position: 0.5 +custom_edit_url: null +--- + +## Enumerations + +- [ClipEmbeddingModelType](enums/ClipEmbeddingModelType.md) +- [DeuceChatStrategy](enums/DeuceChatStrategy.md) +- [IndexStructType](enums/IndexStructType.md) +- [KeywordTableRetrieverMode](enums/KeywordTableRetrieverMode.md) +- [MetadataMode](enums/MetadataMode.md) +- [NodeRelationship](enums/NodeRelationship.md) +- [ObjectType](enums/ObjectType.md) +- [OpenAIEmbeddingModelType](enums/OpenAIEmbeddingModelType.md) +- [SimilarityType](enums/SimilarityType.md) +- [SummaryRetrieverMode](enums/SummaryRetrieverMode.md) +- [Tokenizers](enums/Tokenizers.md) +- [VectorStoreQueryMode](enums/VectorStoreQueryMode.md) + +## Classes + +- [Anthropic](classes/Anthropic.md) +- [BaseDocumentStore](classes/BaseDocumentStore.md) +- [BaseEmbedding](classes/BaseEmbedding.md) +- [BaseInMemoryKVStore](classes/BaseInMemoryKVStore.md) +- [BaseIndex](classes/BaseIndex.md) +- [BaseIndexStore](classes/BaseIndexStore.md) +- [BaseKVStore](classes/BaseKVStore.md) +- [BaseNode](classes/BaseNode.md) +- [CallbackManager](classes/CallbackManager.md) +- [ClipEmbedding](classes/ClipEmbedding.md) +- [CompactAndRefine](classes/CompactAndRefine.md) +- [CondenseQuestionChatEngine](classes/CondenseQuestionChatEngine.md) +- [ContextChatEngine](classes/ContextChatEngine.md) +- [DefaultContextGenerator](classes/DefaultContextGenerator.md) +- [Document](classes/Document.md) +- [HTMLReader](classes/HTMLReader.md) +- [HistoryChatEngine](classes/HistoryChatEngine.md) +- [ImageDocument](classes/ImageDocument.md) +- [ImageNode](classes/ImageNode.md) +- [InMemoryFileSystem](classes/InMemoryFileSystem.md) +- [IndexDict](classes/IndexDict.md) +- [IndexList](classes/IndexList.md) +- [IndexNode](classes/IndexNode.md) +- [IndexStruct](classes/IndexStruct.md) +- [KeywordTable](classes/KeywordTable.md) +- [KeywordTableIndex](classes/KeywordTableIndex.md) +- [KeywordTableLLMRetriever](classes/KeywordTableLLMRetriever.md) +- [KeywordTableRAKERetriever](classes/KeywordTableRAKERetriever.md) +- [KeywordTableSimpleRetriever](classes/KeywordTableSimpleRetriever.md) +- [LLMQuestionGenerator](classes/LLMQuestionGenerator.md) +- [LlamaDeuce](classes/LlamaDeuce.md) +- [MarkdownReader](classes/MarkdownReader.md) +- [MongoDBAtlasVectorSearch](classes/MongoDBAtlasVectorSearch.md) +- [MultiModalEmbedding](classes/MultiModalEmbedding.md) +- [NotionReader](classes/NotionReader.md) +- [OpenAI](classes/OpenAI.md) +- [OpenAIEmbedding](classes/OpenAIEmbedding.md) +- [PDFReader](classes/PDFReader.md) +- [PapaCSVReader](classes/PapaCSVReader.md) +- [Portkey](classes/Portkey.md) +- [PromptHelper](classes/PromptHelper.md) +- [Refine](classes/Refine.md) +- [Response](classes/Response.md) +- [ResponseSynthesizer](classes/ResponseSynthesizer.md) +- [RetrieverQueryEngine](classes/RetrieverQueryEngine.md) +- [SentenceSplitter](classes/SentenceSplitter.md) +- [SimilarityPostprocessor](classes/SimilarityPostprocessor.md) +- [SimpleChatEngine](classes/SimpleChatEngine.md) +- [SimpleChatHistory](classes/SimpleChatHistory.md) +- [SimpleDirectoryReader](classes/SimpleDirectoryReader.md) +- [SimpleDocumentStore](classes/SimpleDocumentStore.md) +- [SimpleIndexStore](classes/SimpleIndexStore.md) +- [SimpleKVStore](classes/SimpleKVStore.md) +- [SimpleMongoReader](classes/SimpleMongoReader.md) +- [SimpleNodeParser](classes/SimpleNodeParser.md) +- [SimpleResponseBuilder](classes/SimpleResponseBuilder.md) +- [SimpleVectorStore](classes/SimpleVectorStore.md) +- [SubQuestionOutputParser](classes/SubQuestionOutputParser.md) +- [SubQuestionQueryEngine](classes/SubQuestionQueryEngine.md) +- [SummaryChatHistory](classes/SummaryChatHistory.md) +- [SummaryIndex](classes/SummaryIndex.md) +- [SummaryIndexLLMRetriever](classes/SummaryIndexLLMRetriever.md) +- [SummaryIndexRetriever](classes/SummaryIndexRetriever.md) +- [TextFileReader](classes/TextFileReader.md) +- [TextNode](classes/TextNode.md) +- [TreeSummarize](classes/TreeSummarize.md) +- [VectorIndexRetriever](classes/VectorIndexRetriever.md) +- [VectorStoreIndex](classes/VectorStoreIndex.md) + +## Interfaces + +- [BaseIndexInit](interfaces/BaseIndexInit.md) +- [BaseNodePostprocessor](interfaces/BaseNodePostprocessor.md) +- [BaseOutputParser](interfaces/BaseOutputParser.md) +- [BaseQueryEngine](interfaces/BaseQueryEngine.md) +- [BaseQuestionGenerator](interfaces/BaseQuestionGenerator.md) +- [BaseReader](interfaces/BaseReader.md) +- [BaseRetriever](interfaces/BaseRetriever.md) +- [BaseTool](interfaces/BaseTool.md) +- [ChatEngine](interfaces/ChatEngine.md) +- [ChatHistory](interfaces/ChatHistory.md) +- [ChatMessage](interfaces/ChatMessage.md) +- [ChatResponse](interfaces/ChatResponse.md) +- [Context](interfaces/Context.md) +- [ContextGenerator](interfaces/ContextGenerator.md) +- [DefaultStreamToken](interfaces/DefaultStreamToken.md) +- [Event](interfaces/Event.md) +- [ExactMatchFilter](interfaces/ExactMatchFilter.md) +- [GenericFileSystem](interfaces/GenericFileSystem.md) +- [LLM](interfaces/LLM.md) +- [LLMMetadata](interfaces/LLMMetadata.md) +- [MessageContentDetail](interfaces/MessageContentDetail.md) +- [MetadataFilters](interfaces/MetadataFilters.md) +- [MetadataInfo](interfaces/MetadataInfo.md) +- [NodeParser](interfaces/NodeParser.md) +- [NodeWithScore](interfaces/NodeWithScore.md) +- [QueryEngineTool](interfaces/QueryEngineTool.md) +- [RefDocInfo](interfaces/RefDocInfo.md) +- [RelatedNodeInfo](interfaces/RelatedNodeInfo.md) +- [RetrievalCallbackResponse](interfaces/RetrievalCallbackResponse.md) +- [ServiceContext](interfaces/ServiceContext.md) +- [ServiceContextOptions](interfaces/ServiceContextOptions.md) +- [StorageContext](interfaces/StorageContext.md) +- [StreamCallbackResponse](interfaces/StreamCallbackResponse.md) +- [StructuredOutput](interfaces/StructuredOutput.md) +- [SubQuestion](interfaces/SubQuestion.md) +- [ToolMetadata](interfaces/ToolMetadata.md) +- [VectorStore](interfaces/VectorStore.md) +- [VectorStoreInfo](interfaces/VectorStoreInfo.md) +- [VectorStoreQuery](interfaces/VectorStoreQuery.md) +- [VectorStoreQueryResult](interfaces/VectorStoreQueryResult.md) +- [VectorStoreQuerySpec](interfaces/VectorStoreQuerySpec.md) +- [WalkableFileSystem](interfaces/WalkableFileSystem.md) + +## Type Aliases + +### AnthropicStreamToken + +Ƭ **AnthropicStreamToken**: `Object` + +#### Type declaration + +| Name | Type | +| :------------ | :---------------------- | +| `completion` | `string` | +| `log_id?` | `string` | +| `model` | `string` | +| `stop?` | `boolean` | +| `stop_reason` | `string` \| `undefined` | + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:42](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L42) + +--- + +### ChoiceSelectPrompt + +Ƭ **ChoiceSelectPrompt**: typeof [`defaultChoiceSelectPrompt`](#defaultchoiceselectprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:165](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L165) + +--- + +### CompleteFileSystem + +Ƭ **CompleteFileSystem**: [`GenericFileSystem`](interfaces/GenericFileSystem.md) & [`WalkableFileSystem`](interfaces/WalkableFileSystem.md) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L49) + +--- + +### CompletionResponse + +Ƭ **CompletionResponse**: [`ChatResponse`](interfaces/ChatResponse.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L51) + +--- + +### CondenseQuestionPrompt + +Ƭ **CondenseQuestionPrompt**: typeof [`defaultCondenseQuestionPrompt`](#defaultcondensequestionprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:346](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L346) + +--- + +### ContextSystemPrompt + +Ƭ **ContextSystemPrompt**: typeof [`defaultContextSystemPrompt`](#defaultcontextsystemprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:367](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L367) + +--- + +### EventTag + +Ƭ **EventTag**: `"intermediate"` \| `"final"` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L10) + +--- + +### EventType + +Ƭ **EventType**: `"retrieve"` \| `"llmPredict"` \| `"wrapper"` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L11) + +--- + +### ImageNodeConstructorProps + +Ƭ **ImageNodeConstructorProps**<`T`\>: `Pick`<[`ImageNode`](classes/ImageNode.md)<`T`\>, `"image"` \| `"id_"`\> & `Partial`<[`ImageNode`](classes/ImageNode.md)<`T`\>\> + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------ | +| `T` | extends [`Metadata`](#metadata) | + +#### Defined in + +[packages/core/src/Node.ts:290](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L290) + +--- + +### ImageType + +Ƭ **ImageType**: `string` \| `Blob` \| `URL` + +#### Defined in + +[packages/core/src/Node.ts:288](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L288) + +--- + +### KeywordExtractPrompt + +Ƭ **KeywordExtractPrompt**: typeof [`defaultKeywordExtractPrompt`](#defaultkeywordextractprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:382](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L382) + +--- + +### ListIndex + +Ƭ **ListIndex**: [`SummaryIndex`](classes/SummaryIndex.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:264](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L264) + +--- + +### ListIndexLLMRetriever + +Ƭ **ListIndexLLMRetriever**: [`SummaryIndexLLMRetriever`](classes/SummaryIndexLLMRetriever.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:134](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L134) + +--- + +### ListIndexRetriever + +Ƭ **ListIndexRetriever**: [`SummaryIndexRetriever`](classes/SummaryIndexRetriever.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndexRetriever.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndexRetriever.ts#L133) + +--- + +### ListRetrieverMode + +Ƭ **ListRetrieverMode**: [`SummaryRetrieverMode`](enums/SummaryRetrieverMode.md) + +#### Defined in + +[packages/core/src/indices/summary/SummaryIndex.ts:265](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/summary/SummaryIndex.ts#L265) + +--- + +### MessageContent + +Ƭ **MessageContent**: `string` \| [`MessageContentDetail`](interfaces/MessageContentDetail.md)[] + +Extended type for the content of a message that allows for multi-modal messages. + +#### Defined in + +[packages/core/src/ChatEngine.ts:350](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L350) + +--- + +### MessageType + +Ƭ **MessageType**: `"user"` \| `"assistant"` \| `"system"` \| `"generic"` \| `"function"` \| `"memory"` + +#### Defined in + +[packages/core/src/llm/LLM.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L31) + +--- + +### Metadata + +Ƭ **Metadata**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/Node.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L27) + +--- + +### OpenAIStreamToken + +Ƭ **OpenAIStreamToken**: [`DefaultStreamToken`](interfaces/DefaultStreamToken.md) + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L41) + +--- + +### QueryKeywordExtractPrompt + +Ƭ **QueryKeywordExtractPrompt**: typeof [`defaultQueryKeywordExtractPrompt`](#defaultquerykeywordextractprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:398](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L398) + +--- + +### RefinePrompt + +Ƭ **RefinePrompt**: typeof [`defaultRefinePrompt`](#defaultrefineprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:106](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L106) + +--- + +### RelatedNodeType + +Ƭ **RelatedNodeType**<`T`\>: [`RelatedNodeInfo`](interfaces/RelatedNodeInfo.md)<`T`\> \| [`RelatedNodeInfo`](interfaces/RelatedNodeInfo.md)<`T`\>[] + +#### Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------- | +| `T` | extends [`Metadata`](#metadata) = [`Metadata`](#metadata) | + +#### Defined in + +[packages/core/src/Node.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L36) + +--- + +### SimpleDirectoryReaderLoadDataProps + +Ƭ **SimpleDirectoryReaderLoadDataProps**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------- | :------------------------------------------------------------ | +| `defaultReader?` | [`BaseReader`](interfaces/BaseReader.md) \| `null` | +| `directoryPath` | `string` | +| `fileExtToReader?` | `Record`<`string`, [`BaseReader`](interfaces/BaseReader.md)\> | +| `fs?` | [`CompleteFileSystem`](#completefilesystem) | + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L52) + +--- + +### SimplePrompt + +Ƭ **SimplePrompt**: (`input`: `Record`<`string`, `string` \| `undefined`\>) => `string` + +#### Type declaration + +▸ (`input`): `string` + +A SimplePrompt is a function that takes a dictionary of inputs and returns a string. +NOTE this is a different interface compared to LlamaIndex Python +NOTE 2: we default to empty string to make it easy to calculate prompt sizes + +##### Parameters + +| Name | Type | +| :------ | :------------------------------------------- | +| `input` | `Record`<`string`, `string` \| `undefined`\> | + +##### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L10) + +--- + +### SubQuestionPrompt + +Ƭ **SubQuestionPrompt**: typeof [`defaultSubQuestionPrompt`](#defaultsubquestionprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:314](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L314) + +--- + +### SummaryPrompt + +Ƭ **SummaryPrompt**: typeof [`defaultSummaryPrompt`](#defaultsummaryprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:73](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L73) + +--- + +### TextQaPrompt + +Ƭ **TextQaPrompt**: typeof [`defaultTextQaPrompt`](#defaulttextqaprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:37](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L37) + +--- + +### TreeSummarizePrompt + +Ƭ **TreeSummarizePrompt**: typeof [`defaultTreeSummarizePrompt`](#defaulttreesummarizeprompt) + +#### Defined in + +[packages/core/src/Prompt.ts:131](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L131) + +## Variables + +### ALL_AVAILABLE_ANTHROPIC_MODELS + +• `Const` **ALL_AVAILABLE_ANTHROPIC_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------------------- | :------------------------------------- | +| `claude-2` | { `contextWindow`: `number` = 200000 } | +| `claude-2.contextWindow` | `number` | +| `claude-instant-1` | { `contextWindow`: `number` = 100000 } | +| `claude-instant-1.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:640](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L640) + +--- + +### ALL_AVAILABLE_LLAMADEUCE_MODELS + +• `Const` **ALL_AVAILABLE_LLAMADEUCE_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Llama-2-13b-chat-4bit` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "meta/llama-2-13b-chat:f4e2de70d66816a838a89eeeb621910adffb0dd0baba3976c96980970978018d" } | +| `Llama-2-13b-chat-4bit.contextWindow` | `number` | +| `Llama-2-13b-chat-4bit.replicateApi` | `string` | +| `Llama-2-13b-chat-old` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "a16z-infra/llama13b-v2-chat:df7690f1994d94e96ad9d568eac121aecf50684a0b0963b25a41cc40061269e5" } | +| `Llama-2-13b-chat-old.contextWindow` | `number` | +| `Llama-2-13b-chat-old.replicateApi` | `string` | +| `Llama-2-70b-chat-4bit` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "meta/llama-2-70b-chat:02e509c789964a7ea8736978a43525956ef40397be9033abf9fd2badfe68c9e3" } | +| `Llama-2-70b-chat-4bit.contextWindow` | `number` | +| `Llama-2-70b-chat-4bit.replicateApi` | `string` | +| `Llama-2-70b-chat-old` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "replicate/llama70b-v2-chat:e951f18578850b652510200860fc4ea62b3b16fac280f83ff32282f87bbd2e48" } | +| `Llama-2-70b-chat-old.contextWindow` | `number` | +| `Llama-2-70b-chat-old.replicateApi` | `string` | +| `Llama-2-7b-chat-4bit` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "meta/llama-2-7b-chat:13c3cdee13ee059ab779f0291d29054dab00a47dad8261375654de5540165fb0" } | +| `Llama-2-7b-chat-4bit.contextWindow` | `number` | +| `Llama-2-7b-chat-4bit.replicateApi` | `string` | +| `Llama-2-7b-chat-old` | { `contextWindow`: `number` = 4096; `replicateApi`: `string` = "a16z-infra/llama7b-v2-chat:4f0a4744c7295c024a1de15e1a63c880d3da035fa1f49bfd344fe076074c8eea" } | +| `Llama-2-7b-chat-old.contextWindow` | `number` | +| `Llama-2-7b-chat-old.replicateApi` | `string` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:370](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L370) + +--- + +### ALL_AVAILABLE_OPENAI_MODELS + +• `Const` **ALL_AVAILABLE_OPENAI_MODELS**: `Object` + +We currently support GPT-3.5 and GPT-4 models + +#### Type declaration + +| Name | Type | +| :----------------------------------- | :------------------------------------- | +| `gpt-3.5-turbo` | { `contextWindow`: `number` = 4096 } | +| `gpt-3.5-turbo.contextWindow` | `number` | +| `gpt-3.5-turbo-1106` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-1106.contextWindow` | `number` | +| `gpt-3.5-turbo-16k` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-16k.contextWindow` | `number` | +| `gpt-4` | { `contextWindow`: `number` = 8192 } | +| `gpt-4.contextWindow` | `number` | +| `gpt-4-1106-preview` | { `contextWindow`: `number` = 128000 } | +| `gpt-4-1106-preview.contextWindow` | `number` | +| `gpt-4-32k` | { `contextWindow`: `number` = 32768 } | +| `gpt-4-32k.contextWindow` | `number` | +| `gpt-4-vision-preview` | { `contextWindow`: `number` = 8192 } | +| `gpt-4-vision-preview.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:119](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L119) + +--- + +### DEFAULT_CHUNK_OVERLAP + +• `Const` **DEFAULT_CHUNK_OVERLAP**: `20` + +#### Defined in + +[packages/core/src/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L5) + +--- + +### DEFAULT_CHUNK_OVERLAP_RATIO + +• `Const` **DEFAULT_CHUNK_OVERLAP_RATIO**: `0.1` + +#### Defined in + +[packages/core/src/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L6) + +--- + +### DEFAULT_CHUNK_SIZE + +• `Const` **DEFAULT_CHUNK_SIZE**: `1024` + +#### Defined in + +[packages/core/src/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L4) + +--- + +### DEFAULT_COLLECTION + +• `Const` **DEFAULT_COLLECTION**: `"data"` + +#### Defined in + +[packages/core/src/storage/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L1) + +--- + +### DEFAULT_CONTEXT_WINDOW + +• `Const` **DEFAULT_CONTEXT_WINDOW**: `3900` + +#### Defined in + +[packages/core/src/constants.ts:1](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L1) + +--- + +### DEFAULT_DOC_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_DOC_STORE_PERSIST_FILENAME**: `"doc_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L4) + +--- + +### DEFAULT_EMBEDDING_DIM + +• `Const` **DEFAULT_EMBEDDING_DIM**: `1536` + +#### Defined in + +[packages/core/src/constants.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L10) + +--- + +### DEFAULT_FS + +• `Const` **DEFAULT_FS**: [`GenericFileSystem`](interfaces/GenericFileSystem.md) \| [`CompleteFileSystem`](#completefilesystem) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L62) + +--- + +### DEFAULT_GRAPH_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_GRAPH_STORE_PERSIST_FILENAME**: `"graph_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L6) + +--- + +### DEFAULT_INDEX_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_INDEX_STORE_PERSIST_FILENAME**: `"index_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:3](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L3) + +--- + +### DEFAULT_NAMESPACE + +• `Const` **DEFAULT_NAMESPACE**: `"docstore"` + +#### Defined in + +[packages/core/src/storage/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L7) + +--- + +### DEFAULT_NUM_OUTPUTS + +• `Const` **DEFAULT_NUM_OUTPUTS**: `256` + +#### Defined in + +[packages/core/src/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L2) + +--- + +### DEFAULT_PADDING + +• `Const` **DEFAULT_PADDING**: `5` + +#### Defined in + +[packages/core/src/constants.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L11) + +--- + +### DEFAULT_PERSIST_DIR + +• `Const` **DEFAULT_PERSIST_DIR**: `"./storage"` + +#### Defined in + +[packages/core/src/storage/constants.ts:2](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L2) + +--- + +### DEFAULT_SIMILARITY_TOP_K + +• `Const` **DEFAULT_SIMILARITY_TOP_K**: `2` + +#### Defined in + +[packages/core/src/constants.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/constants.ts#L7) + +--- + +### DEFAULT_VECTOR_STORE_PERSIST_FILENAME + +• `Const` **DEFAULT_VECTOR_STORE_PERSIST_FILENAME**: `"vector_store.json"` + +#### Defined in + +[packages/core/src/storage/constants.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/constants.ts#L5) + +--- + +### FILE_EXT_TO_READER + +• `Const` **FILE_EXT_TO_READER**: `Record`<`string`, [`BaseReader`](interfaces/BaseReader.md)\> + +#### Defined in + +[packages/core/src/readers/SimpleDirectoryReader.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/SimpleDirectoryReader.ts#L38) + +--- + +### GPT35_MODELS + +• `Const` **GPT35_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :--------------------------------- | :------------------------------------ | +| `gpt-3.5-turbo` | { `contextWindow`: `number` = 4096 } | +| `gpt-3.5-turbo.contextWindow` | `number` | +| `gpt-3.5-turbo-1106` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-1106.contextWindow` | `number` | +| `gpt-3.5-turbo-16k` | { `contextWindow`: `number` = 16384 } | +| `gpt-3.5-turbo-16k.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:110](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L110) + +--- + +### GPT4_MODELS + +• `Const` **GPT4_MODELS**: `Object` + +#### Type declaration + +| Name | Type | +| :----------------------------------- | :------------------------------------- | +| `gpt-4` | { `contextWindow`: `number` = 8192 } | +| `gpt-4.contextWindow` | `number` | +| `gpt-4-1106-preview` | { `contextWindow`: `number` = 128000 } | +| `gpt-4-1106-preview.contextWindow` | `number` | +| `gpt-4-32k` | { `contextWindow`: `number` = 32768 } | +| `gpt-4-32k.contextWindow` | `number` | +| `gpt-4-vision-preview` | { `contextWindow`: `number` = 8192 } | +| `gpt-4-vision-preview.contextWindow` | `number` | + +#### Defined in + +[packages/core/src/llm/LLM.ts:103](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L103) + +--- + +### globalsHelper + +• `Const` **globalsHelper**: `GlobalsHelper` + +#### Defined in + +[packages/core/src/GlobalsHelper.ts:76](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/GlobalsHelper.ts#L76) + +--- + +### unixLineSeparator + +• `Const` **unixLineSeparator**: `"\n"` + +#### Defined in + +[packages/core/src/TextSplitter.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L44) + +--- + +### unixParagraphSeparator + +• `Const` **unixParagraphSeparator**: `string` + +#### Defined in + +[packages/core/src/TextSplitter.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L46) + +--- + +### windowsLineSeparator + +• `Const` **windowsLineSeparator**: `"\r\n"` + +#### Defined in + +[packages/core/src/TextSplitter.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L45) + +--- + +### windowsParagraphSeparator + +• `Const` **windowsParagraphSeparator**: `string` + +#### Defined in + +[packages/core/src/TextSplitter.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L47) + +## Functions + +### anthropicTextQaPrompt + +▸ **anthropicTextQaPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L39) + +--- + +### buildToolsText + +▸ **buildToolsText**(`tools`): `string` + +#### Parameters + +| Name | Type | +| :------ | :--------------------------------------------- | +| `tools` | [`ToolMetadata`](interfaces/ToolMetadata.md)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:243](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L243) + +--- + +### cjkSentenceTokenizer + +▸ **cjkSentenceTokenizer**(`text`): `null` \| `RegExpMatchArray` + +Tokenizes sentences. Suitable for Chinese, Japanese, and Korean. + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`null` \| `RegExpMatchArray` + +#### Defined in + +[packages/core/src/TextSplitter.ts:36](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L36) + +--- + +### defaultChoiceSelectPrompt + +▸ **defaultChoiceSelectPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:133](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L133) + +--- + +### defaultCondenseQuestionPrompt + +▸ **defaultCondenseQuestionPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:330](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L330) + +--- + +### defaultContextSystemPrompt + +▸ **defaultContextSystemPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:360](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L360) + +--- + +### defaultKeywordExtractPrompt + +▸ **defaultKeywordExtractPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:369](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L369) + +--- + +### defaultQueryKeywordExtractPrompt + +▸ **defaultQueryKeywordExtractPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:384](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L384) + +--- + +### defaultRefinePrompt + +▸ **defaultRefinePrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L91) + +--- + +### defaultSubQuestionPrompt + +▸ **defaultSubQuestionPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:284](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L284) + +--- + +### defaultSummaryPrompt + +▸ **defaultSummaryPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L62) + +--- + +### defaultTextQaPrompt + +▸ **defaultTextQaPrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L27) + +--- + +### defaultTreeSummarizePrompt + +▸ **defaultTreeSummarizePrompt**(`«destructured»`): `string` + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `«destructured»` | `Object` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:121](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L121) + +--- + +### englishSentenceTokenizer + +▸ **englishSentenceTokenizer**(`text`): `null` \| `RegExpMatchArray` + +Tokenizes sentences. Suitable for English and most European languages. + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `text` | `string` | + +#### Returns + +`null` \| `RegExpMatchArray` + +#### Defined in + +[packages/core/src/TextSplitter.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/TextSplitter.ts#L26) + +--- + +### exists + +▸ **exists**(`fs`, `path`): `Promise`<`boolean`\> + +Checks if a file exists. +Analogous to the os.path.exists function from Python. + +#### Parameters + +| Name | Type | Description | +| :----- | :----------------------------------------------------- | :----------------------------- | +| `fs` | [`GenericFileSystem`](interfaces/GenericFileSystem.md) | The filesystem to use. | +| `path` | `string` | The path to the file to check. | + +#### Returns + +`Promise`<`boolean`\> + +A promise that resolves to true if the file exists, false otherwise. + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L74) + +--- + +### getBiggestPrompt + +▸ **getBiggestPrompt**(`prompts`): [`SimplePrompt`](#simpleprompt) + +Get biggest empty prompt size from a list of prompts. +Used to calculate the maximum size of inputs to the LLM. + +#### Parameters + +| Name | Type | +| :-------- | :-------------------------------- | +| `prompts` | [`SimplePrompt`](#simpleprompt)[] | + +#### Returns + +[`SimplePrompt`](#simpleprompt) + +#### Defined in + +[packages/core/src/PromptHelper.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L21) + +--- + +### getEmptyPromptTxt + +▸ **getEmptyPromptTxt**(`prompt`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------------------------------ | +| `prompt` | [`SimplePrompt`](#simpleprompt) | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/PromptHelper.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/PromptHelper.ts#L11) + +--- + +### getNodeFS + +▸ **getNodeFS**(): [`CompleteFileSystem`](#completefilesystem) + +#### Returns + +[`CompleteFileSystem`](#completefilesystem) + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L51) + +--- + +### getNodesFromDocument + +▸ **getNodesFromDocument**(`doc`, `textSplitter`, `includeMetadata?`, `includePrevNextRel?`): [`ImageDocument`](classes/ImageDocument.md)<`any`\>[] \| [`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\>[] + +Generates an array of nodes from a document. + +#### Parameters + +| Name | Type | Default value | Description | +| :------------------- | :---------------------------------------------------------- | :------------ | :--------------------------------------------------------------- | +| `doc` | [`BaseNode`](classes/BaseNode.md)<[`Metadata`](#metadata)\> | `undefined` | - | +| `textSplitter` | [`SentenceSplitter`](classes/SentenceSplitter.md) | `undefined` | The text splitter to use. | +| `includeMetadata` | `boolean` | `true` | Whether to include metadata in the nodes. | +| `includePrevNextRel` | `boolean` | `true` | Whether to include previous and next relationships in the nodes. | + +#### Returns + +[`ImageDocument`](classes/ImageDocument.md)<`any`\>[] \| [`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\>[] + +An array of nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:35](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L35) + +--- + +### getResponseBuilder + +▸ **getResponseBuilder**(`serviceContext`, `responseMode?`): `BaseResponseBuilder` + +#### Parameters + +| Name | Type | +| :--------------- | :----------------------------------------------- | +| `serviceContext` | [`ServiceContext`](interfaces/ServiceContext.md) | +| `responseMode?` | `ResponseMode` | + +#### Returns + +`BaseResponseBuilder` + +#### Defined in + +[packages/core/src/ResponseSynthesizer.ts:271](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ResponseSynthesizer.ts#L271) + +--- + +### getTextSplitsFromDocument + +▸ **getTextSplitsFromDocument**(`document`, `textSplitter`): `string`[] + +Splits the text of a document into smaller parts. + +#### Parameters + +| Name | Type | Description | +| :------------- | :---------------------------------------------------------- | :------------------------ | +| `document` | [`Document`](classes/Document.md)<[`Metadata`](#metadata)\> | The document to split. | +| `textSplitter` | [`SentenceSplitter`](classes/SentenceSplitter.md) | The text splitter to use. | + +#### Returns + +`string`[] + +An array of text splits. + +#### Defined in + +[packages/core/src/NodeParser.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L17) + +--- + +### getTopKEmbeddings + +▸ **getTopKEmbeddings**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingIds?`, `similarityCutoff?`): [`number`[], `any`[]] + +Get the top K embeddings from a list of embeddings ordered by similarity to the query. + +#### Parameters + +| Name | Type | Default value | Description | +| :----------------- | :----------------- | :------------------------- | :-------------------------------------------- | +| `queryEmbedding` | `number`[] | `undefined` | | +| `embeddings` | `number`[][] | `undefined` | list of embeddings to consider | +| `similarityTopK` | `number` | `DEFAULT_SIMILARITY_TOP_K` | max number of embeddings to return, default 2 | +| `embeddingIds` | `null` \| `any`[] | `null` | ids of embeddings in the embeddings list | +| `similarityCutoff` | `null` \| `number` | `null` | minimum similarity score | + +#### Returns + +[`number`[], `any`[]] + +#### Defined in + +[packages/core/src/embeddings/utils.ts:69](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/utils.ts#L69) + +--- + +### getTopKEmbeddingsLearner + +▸ **getTopKEmbeddingsLearner**(`queryEmbedding`, `embeddings`, `similarityTopK?`, `embeddingsIds?`, `queryMode?`): [`number`[], `any`[]] + +#### Parameters + +| Name | Type | Default value | +| :---------------- | :------------------------------------------------------ | :------------------------- | +| `queryEmbedding` | `number`[] | `undefined` | +| `embeddings` | `number`[][] | `undefined` | +| `similarityTopK?` | `number` | `undefined` | +| `embeddingsIds?` | `any`[] | `undefined` | +| `queryMode` | [`VectorStoreQueryMode`](enums/VectorStoreQueryMode.md) | `VectorStoreQueryMode.SVM` | + +#### Returns + +[`number`[], `any`[]] + +#### Defined in + +[packages/core/src/embeddings/utils.ts:111](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/utils.ts#L111) + +--- + +### getTopKMMREmbeddings + +▸ **getTopKMMREmbeddings**(`queryEmbedding`, `embeddings`, `similarityFn?`, `similarityTopK?`, `embeddingIds?`, `_similarityCutoff?`, `mmrThreshold?`): [`number`[], `any`[]] + +#### Parameters + +| Name | Type | Default value | +| :------------------ | :----------------------------------------- | :------------ | +| `queryEmbedding` | `number`[] | `undefined` | +| `embeddings` | `number`[][] | `undefined` | +| `similarityFn` | `null` \| (...`args`: `any`[]) => `number` | `null` | +| `similarityTopK` | `null` \| `number` | `null` | +| `embeddingIds` | `null` \| `any`[] | `null` | +| `_similarityCutoff` | `null` \| `number` | `null` | +| `mmrThreshold` | `null` \| `number` | `null` | + +#### Returns + +[`number`[], `any`[]] + +#### Defined in + +[packages/core/src/embeddings/utils.ts:123](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/utils.ts#L123) + +--- + +### jsonToIndexStruct + +▸ **jsonToIndexStruct**(`json`): [`IndexStruct`](classes/IndexStruct.md) + +#### Parameters + +| Name | Type | +| :----- | :---- | +| `json` | `any` | + +#### Returns + +[`IndexStruct`](classes/IndexStruct.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:74](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L74) + +--- + +### jsonToNode + +▸ **jsonToNode**(`json`, `type?`): [`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\> + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------- | +| `json` | `any` | +| `type?` | [`ObjectType`](enums/ObjectType.md) | + +#### Returns + +[`TextNode`](classes/TextNode.md)<[`Metadata`](#metadata)\> + +#### Defined in + +[packages/core/src/Node.ts:268](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L268) + +--- + +### messagesToHistoryStr + +▸ **messagesToHistoryStr**(`messages`): `string` + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------- | +| `messages` | [`ChatMessage`](interfaces/ChatMessage.md)[] | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/Prompt.ts:348](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Prompt.ts#L348) + +--- + +### parseJsonMarkdown + +▸ **parseJsonMarkdown**(`text`): `any` + +#### Parameters + +| Name | Type | Description | +| :----- | :------- | :------------------------- | +| `text` | `string` | A markdown block with JSON | + +#### Returns + +`any` + +parsed JSON object + +#### Defined in + +[packages/core/src/OutputParser.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L56) + +--- + +### readImage + +▸ **readImage**(`input`): `Promise`<`RawImage`\> + +#### Parameters + +| Name | Type | +| :------ | :------------------------ | +| `input` | [`ImageType`](#imagetype) | + +#### Returns + +`Promise`<`RawImage`\> + +#### Defined in + +[packages/core/src/embeddings/utils.ts:188](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/utils.ts#L188) + +--- + +### serviceContextFromDefaults + +▸ **serviceContextFromDefaults**(`options?`): [`ServiceContext`](interfaces/ServiceContext.md) + +#### Parameters + +| Name | Type | +| :--------- | :------------------------------------------------------------- | +| `options?` | [`ServiceContextOptions`](interfaces/ServiceContextOptions.md) | + +#### Returns + +[`ServiceContext`](interfaces/ServiceContext.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L30) + +--- + +### serviceContextFromServiceContext + +▸ **serviceContextFromServiceContext**(`serviceContext`, `options`): `Object` + +#### Parameters + +| Name | Type | +| :--------------- | :------------------------------------------------------------- | +| `serviceContext` | [`ServiceContext`](interfaces/ServiceContext.md) | +| `options` | [`ServiceContextOptions`](interfaces/ServiceContextOptions.md) | + +#### Returns + +`Object` + +| Name | Type | +| :---------------- | :---------------------------------------------- | +| `callbackManager` | [`CallbackManager`](classes/CallbackManager.md) | +| `embedModel` | [`BaseEmbedding`](classes/BaseEmbedding.md) | +| `llm` | [`LLM`](interfaces/LLM.md) | +| `nodeParser` | [`NodeParser`](interfaces/NodeParser.md) | +| `promptHelper` | [`PromptHelper`](classes/PromptHelper.md) | + +#### Defined in + +[packages/core/src/ServiceContext.ts:48](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L48) + +--- + +### similarity + +▸ **similarity**(`embedding1`, `embedding2`, `mode?`): `number` + +The similarity between two embeddings. + +#### Parameters + +| Name | Type | Default value | +| :----------- | :------------------------------------------ | :----------------------- | +| `embedding1` | `number`[] | `undefined` | +| `embedding2` | `number`[] | `undefined` | +| `mode` | [`SimilarityType`](enums/SimilarityType.md) | `SimilarityType.DEFAULT` | + +#### Returns + +`number` + +similarity score with higher numbers meaning the two embeddings are more similar + +#### Defined in + +[packages/core/src/embeddings/utils.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/embeddings/utils.ts#L15) + +--- + +### storageContextFromDefaults + +▸ **storageContextFromDefaults**(`«destructured»`): `Promise`<[`StorageContext`](interfaces/StorageContext.md)\> + +#### Parameters + +| Name | Type | +| :--------------- | :-------------- | +| `«destructured»` | `BuilderParams` | + +#### Returns + +`Promise`<[`StorageContext`](interfaces/StorageContext.md)\> + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/StorageContext.ts#L24) + +--- + +### walk + +▸ **walk**(`fs`, `dirPath`): `AsyncIterable`<`string`\> + +Recursively traverses a directory and yields all the paths to the files in it. + +#### Parameters + +| Name | Type | Description | +| :-------- | :------------------------------------------------------- | :------------------------------------- | +| `fs` | [`WalkableFileSystem`](interfaces/WalkableFileSystem.md) | The filesystem to use. | +| `dirPath` | `string` | The path to the directory to traverse. | + +#### Returns + +`AsyncIterable`<`string`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:91](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L91) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseIndexInit.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseIndexInit.md new file mode 100644 index 0000000000000000000000000000000000000000..27902c1548eb683a38fe2dbbd7fbca5fbe586ae1 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseIndexInit.md @@ -0,0 +1,73 @@ +--- +id: "BaseIndexInit" +title: "Interface: BaseIndexInit<T>" +sidebar_label: "BaseIndexInit" +sidebar_position: 0 +custom_edit_url: null +--- + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](../classes/BaseDocumentStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:143](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L143) + +--- + +### indexStore + +• `Optional` **indexStore**: [`BaseIndexStore`](../classes/BaseIndexStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:145](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L145) + +--- + +### indexStruct + +• **indexStruct**: `T` + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:146](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L146) + +--- + +### serviceContext + +• **serviceContext**: [`ServiceContext`](ServiceContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:141](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L141) + +--- + +### storageContext + +• **storageContext**: [`StorageContext`](StorageContext.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:142](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L142) + +--- + +### vectorStore + +• `Optional` **vectorStore**: [`VectorStore`](VectorStore.md) + +#### Defined in + +[packages/core/src/indices/BaseIndex.ts:144](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseIndex.ts#L144) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseNodePostprocessor.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseNodePostprocessor.md new file mode 100644 index 0000000000000000000000000000000000000000..84557d7598fd5726e360788a5d9be603e652adbd --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseNodePostprocessor.md @@ -0,0 +1,35 @@ +--- +id: "BaseNodePostprocessor" +title: "Interface: BaseNodePostprocessor" +sidebar_label: "BaseNodePostprocessor" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implemented by + +- [`SimilarityPostprocessor`](../classes/SimilarityPostprocessor.md) + +## Properties + +### postprocessNodes + +• **postprocessNodes**: (`nodes`: [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[]) => [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Type declaration + +▸ (`nodes`): [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +##### Parameters + +| Name | Type | +| :------ | :----------------------------------------------------------------- | +| `nodes` | [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] | + +##### Returns + +[`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/indices/BaseNodePostprocessor.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/indices/BaseNodePostprocessor.ts#L4) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseOutputParser.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseOutputParser.md new file mode 100644 index 0000000000000000000000000000000000000000..5642c32d8ed91abe3f3a87f3dd13f9299ea6637d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseOutputParser.md @@ -0,0 +1,59 @@ +--- +id: "BaseOutputParser" +title: "Interface: BaseOutputParser<T>" +sidebar_label: "BaseOutputParser" +sidebar_position: 0 +custom_edit_url: null +--- + +An OutputParser is used to extract structured data from the raw output of the LLM. + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Implemented by + +- [`SubQuestionOutputParser`](../classes/SubQuestionOutputParser.md) + +## Methods + +### format + +▸ **format**(`output`): `string` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +`string` + +#### Defined in + +[packages/core/src/OutputParser.ts:8](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L8) + +--- + +### parse + +▸ **parse**(`output`): `T` + +#### Parameters + +| Name | Type | +| :------- | :------- | +| `output` | `string` | + +#### Returns + +`T` + +#### Defined in + +[packages/core/src/OutputParser.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L7) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseQueryEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseQueryEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..df5fea0a0edbc4981222e986244ce15b5e16b7eb --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseQueryEngine.md @@ -0,0 +1,37 @@ +--- +id: "BaseQueryEngine" +title: "Interface: BaseQueryEngine" +sidebar_label: "BaseQueryEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +A query engine is a question answerer that can use one or more steps. + +## Implemented by + +- [`RetrieverQueryEngine`](../classes/RetrieverQueryEngine.md) +- [`SubQuestionQueryEngine`](../classes/SubQuestionQueryEngine.md) + +## Methods + +### query + +▸ **query**(`query`, `parentEvent?`): `Promise`<[`Response`](../classes/Response.md)\> + +Query the query engine and get a response. + +#### Parameters + +| Name | Type | +| :------------- | :------------------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](Event.md) | + +#### Returns + +`Promise`<[`Response`](../classes/Response.md)\> + +#### Defined in + +[packages/core/src/QueryEngine.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QueryEngine.ts#L25) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseQuestionGenerator.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseQuestionGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..c62d21401a67ac3d361e942a85685ea201875400 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseQuestionGenerator.md @@ -0,0 +1,34 @@ +--- +id: "BaseQuestionGenerator" +title: "Interface: BaseQuestionGenerator" +sidebar_label: "BaseQuestionGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +QuestionGenerators generate new questions for the LLM using tools and a user query. + +## Implemented by + +- [`LLMQuestionGenerator`](../classes/LLMQuestionGenerator.md) + +## Methods + +### generate + +▸ **generate**(`tools`, `query`): `Promise`<[`SubQuestion`](SubQuestion.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :---------------------------------- | +| `tools` | [`ToolMetadata`](ToolMetadata.md)[] | +| `query` | `string` | + +#### Returns + +`Promise`<[`SubQuestion`](SubQuestion.md)[]\> + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L23) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseReader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseReader.md new file mode 100644 index 0000000000000000000000000000000000000000..46f840f3f23157c9eebbf438ce6280a58203c7ce --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseReader.md @@ -0,0 +1,40 @@ +--- +id: "BaseReader" +title: "Interface: BaseReader" +sidebar_label: "BaseReader" +sidebar_position: 0 +custom_edit_url: null +--- + +A reader takes imports data into Document objects. + +## Implemented by + +- [`HTMLReader`](../classes/HTMLReader.md) +- [`MarkdownReader`](../classes/MarkdownReader.md) +- [`NotionReader`](../classes/NotionReader.md) +- [`PDFReader`](../classes/PDFReader.md) +- [`PapaCSVReader`](../classes/PapaCSVReader.md) +- [`SimpleDirectoryReader`](../classes/SimpleDirectoryReader.md) +- [`SimpleMongoReader`](../classes/SimpleMongoReader.md) +- [`TextFileReader`](../classes/TextFileReader.md) + +## Methods + +### loadData + +▸ **loadData**(`...args`): `Promise`<[`Document`](../classes/Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :-------- | :------ | +| `...args` | `any`[] | + +#### Returns + +`Promise`<[`Document`](../classes/Document.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/readers/base.ts:7](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/readers/base.ts#L7) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseRetriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseRetriever.md new file mode 100644 index 0000000000000000000000000000000000000000..3ee1d3b5be2e13eeb20dbfff5362e0d2a742b9d3 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseRetriever.md @@ -0,0 +1,51 @@ +--- +id: "BaseRetriever" +title: "Interface: BaseRetriever" +sidebar_label: "BaseRetriever" +sidebar_position: 0 +custom_edit_url: null +--- + +Retrievers retrieve the nodes that most closely match our query in similarity. + +## Implemented by + +- [`SummaryIndexLLMRetriever`](../classes/SummaryIndexLLMRetriever.md) +- [`SummaryIndexRetriever`](../classes/SummaryIndexRetriever.md) +- [`VectorIndexRetriever`](../classes/VectorIndexRetriever.md) + +## Methods + +### getServiceContext + +▸ **getServiceContext**(): [`ServiceContext`](ServiceContext.md) + +#### Returns + +[`ServiceContext`](ServiceContext.md) + +#### Defined in + +[packages/core/src/Retriever.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Retriever.ts#L14) + +--- + +### retrieve + +▸ **retrieve**(`query`, `parentEvent?`, `preFilters?`): `Promise`<[`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------ | +| `query` | `string` | +| `parentEvent?` | [`Event`](Event.md) | +| `preFilters?` | `unknown` | + +#### Returns + +`Promise`<[`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[]\> + +#### Defined in + +[packages/core/src/Retriever.ts:9](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Retriever.ts#L9) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseTool.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseTool.md new file mode 100644 index 0000000000000000000000000000000000000000..0e10e03c02596c2bc22153dff1c19b786619100b --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/BaseTool.md @@ -0,0 +1,25 @@ +--- +id: "BaseTool" +title: "Interface: BaseTool" +sidebar_label: "BaseTool" +sidebar_position: 0 +custom_edit_url: null +--- + +Simple Tool interface. Likely to change. + +## Hierarchy + +- **`BaseTool`** + + ↳ [`QueryEngineTool`](QueryEngineTool.md) + +## Properties + +### metadata + +• **metadata**: [`ToolMetadata`](ToolMetadata.md) + +#### Defined in + +[packages/core/src/Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Tool.ts#L12) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatEngine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatEngine.md new file mode 100644 index 0000000000000000000000000000000000000000..16bf128108845cbed33108b4b72b71b1465f2b9c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatEngine.md @@ -0,0 +1,62 @@ +--- +id: "ChatEngine" +title: "Interface: ChatEngine" +sidebar_label: "ChatEngine" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatEngine is used to handle back and forth chats between the application and the LLM. + +## Implemented by + +- [`CondenseQuestionChatEngine`](../classes/CondenseQuestionChatEngine.md) +- [`ContextChatEngine`](../classes/ContextChatEngine.md) +- [`SimpleChatEngine`](../classes/SimpleChatEngine.md) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`message`, `chatHistory?`, `streaming?`): `Promise`<`R`\> + +Send message along with the class's current chat history to the LLM. + +#### Type parameters + +| Name | Type | +| :--- | :--------------------------------------------------------------------------------------------------------- | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`Response`](../classes/Response.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :------------------------------------- | :----------------------------------------------------------------- | +| `message` | [`MessageContent`](../#messagecontent) | | +| `chatHistory?` | [`ChatMessage`](ChatMessage.md)[] | optional chat history if you want to customize the chat history | +| `streaming?` | `T` | optional streaming flag, which auto-sets the return value if True. | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L29) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/ChatEngine.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L41) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatHistory.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatHistory.md new file mode 100644 index 0000000000000000000000000000000000000000..0f4850a126dc86f2f83a5ec78e2f412ef4071645 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatHistory.md @@ -0,0 +1,100 @@ +--- +id: "ChatHistory" +title: "Interface: ChatHistory" +sidebar_label: "ChatHistory" +sidebar_position: 0 +custom_edit_url: null +--- + +A ChatHistory is used to keep the state of back and forth chat messages + +## Implemented by + +- [`SimpleChatHistory`](../classes/SimpleChatHistory.md) +- [`SummaryChatHistory`](../classes/SummaryChatHistory.md) + +## Properties + +### messages + +• **messages**: [`ChatMessage`](ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L12) + +## Methods + +### addMessage + +▸ **addMessage**(`message`): `void` + +Adds a message to the chat history. + +#### Parameters + +| Name | Type | +| :-------- | :------------------------------ | +| `message` | [`ChatMessage`](ChatMessage.md) | + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/ChatHistory.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L17) + +--- + +### newMessages + +▸ **newMessages**(): [`ChatMessage`](ChatMessage.md)[] + +Returns the new messages since the last call to this function (or since calling the constructor) + +#### Returns + +[`ChatMessage`](ChatMessage.md)[] + +#### Defined in + +[packages/core/src/ChatHistory.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L32) + +--- + +### requestMessages + +▸ **requestMessages**(`transientMessages?`): `Promise`<[`ChatMessage`](ChatMessage.md)[]\> + +Returns the messages that should be used as input to the LLM. + +#### Parameters + +| Name | Type | +| :------------------- | :-------------------------------- | +| `transientMessages?` | [`ChatMessage`](ChatMessage.md)[] | + +#### Returns + +`Promise`<[`ChatMessage`](ChatMessage.md)[]\> + +#### Defined in + +[packages/core/src/ChatHistory.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L22) + +--- + +### reset + +▸ **reset**(): `void` + +Resets the chat history so that it's empty. + +#### Returns + +`void` + +#### Defined in + +[packages/core/src/ChatHistory.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatHistory.ts#L27) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatMessage.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatMessage.md new file mode 100644 index 0000000000000000000000000000000000000000..e6ac7185652ae1f0f642b0d877b32647adb3999a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatMessage.md @@ -0,0 +1,27 @@ +--- +id: "ChatMessage" +title: "Interface: ChatMessage" +sidebar_label: "ChatMessage" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### content + +• **content**: `any` + +#### Defined in + +[packages/core/src/llm/LLM.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L40) + +--- + +### role + +• **role**: [`MessageType`](../#messagetype) + +#### Defined in + +[packages/core/src/llm/LLM.ts:41](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L41) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatResponse.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..fdff55f2fdc9463ba724aa74f86199d288ca4408 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ChatResponse.md @@ -0,0 +1,37 @@ +--- +id: "ChatResponse" +title: "Interface: ChatResponse" +sidebar_label: "ChatResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### delta + +• `Optional` **delta**: `string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:47](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L47) + +--- + +### message + +• **message**: [`ChatMessage`](ChatMessage.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L45) + +--- + +### raw + +• `Optional` **raw**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:46](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L46) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/Context.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/Context.md new file mode 100644 index 0000000000000000000000000000000000000000..d5502d554f21fa372d0444bfd2bd289502d15f52 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/Context.md @@ -0,0 +1,27 @@ +--- +id: "Context" +title: "Interface: Context" +sidebar_label: "Context" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### message + +• **message**: [`ChatMessage`](ChatMessage.md) + +#### Defined in + +[packages/core/src/ChatEngine.ts:175](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L175) + +--- + +### nodes + +• **nodes**: [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/ChatEngine.ts:176](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L176) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ContextGenerator.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ContextGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..8e493af649a79f681ce21ed4a82f4c81af774c3d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ContextGenerator.md @@ -0,0 +1,32 @@ +--- +id: "ContextGenerator" +title: "Interface: ContextGenerator" +sidebar_label: "ContextGenerator" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implemented by + +- [`DefaultContextGenerator`](../classes/DefaultContextGenerator.md) + +## Methods + +### generate + +▸ **generate**(`message`, `parentEvent?`): `Promise`<[`Context`](Context.md)\> + +#### Parameters + +| Name | Type | +| :------------- | :------------------ | +| `message` | `string` | +| `parentEvent?` | [`Event`](Event.md) | + +#### Returns + +`Promise`<[`Context`](Context.md)\> + +#### Defined in + +[packages/core/src/ChatEngine.ts:180](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L180) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/DefaultStreamToken.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/DefaultStreamToken.md new file mode 100644 index 0000000000000000000000000000000000000000..2dfe47789d78699f8fc104c0ef7cd2e65fffab17 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/DefaultStreamToken.md @@ -0,0 +1,57 @@ +--- +id: "DefaultStreamToken" +title: "Interface: DefaultStreamToken" +sidebar_label: "DefaultStreamToken" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### choices + +• **choices**: { `delta`: { `content?`: `null` \| `string` ; `role?`: `"function"` \| `"user"` \| `"assistant"` \| `"system"` \| `"tool"` } ; `finish_reason`: `null` \| `string` ; `index`: `number` }[] + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:29](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L29) + +--- + +### created + +• **created**: `number` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L27) + +--- + +### id + +• **id**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:25](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L25) + +--- + +### model + +• **model**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L28) + +--- + +### object + +• **object**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L26) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/Event.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/Event.md new file mode 100644 index 0000000000000000000000000000000000000000..efd33c78f09f6354334256adf6c3919c3ca2f0e4 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/Event.md @@ -0,0 +1,47 @@ +--- +id: "Event" +title: "Interface: Event" +sidebar_label: "Event" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### id + +• **id**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L13) + +--- + +### parentId + +• `Optional` **parentId**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L16) + +--- + +### tags + +• `Optional` **tags**: [`EventTag`](../#eventtag)[] + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L15) + +--- + +### type + +• **type**: [`EventType`](../#eventtype) + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L14) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ExactMatchFilter.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ExactMatchFilter.md new file mode 100644 index 0000000000000000000000000000000000000000..058dc2f2834f80a52c268c0909dd2882afd4ba5b --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ExactMatchFilter.md @@ -0,0 +1,37 @@ +--- +id: "ExactMatchFilter" +title: "Interface: ExactMatchFilter" +sidebar_label: "ExactMatchFilter" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### filterType + +• **filterType**: `"ExactMatch"` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L22) + +--- + +### key + +• **key**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L23) + +--- + +### value + +• **value**: `string` \| `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L24) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/GenericFileSystem.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/GenericFileSystem.md new file mode 100644 index 0000000000000000000000000000000000000000..eec2f54d1e2352740a705874cbfbcb9559789e2f --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/GenericFileSystem.md @@ -0,0 +1,100 @@ +--- +id: "GenericFileSystem" +title: "Interface: GenericFileSystem" +sidebar_label: "GenericFileSystem" +sidebar_position: 0 +custom_edit_url: null +--- + +A filesystem interface that is meant to be compatible with +the 'fs' module from Node.js. +Allows for the use of similar inteface implementation on +browsers. + +## Implemented by + +- [`InMemoryFileSystem`](../classes/InMemoryFileSystem.md) + +## Methods + +### access + +▸ **access**(`path`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L12) + +--- + +### mkdir + +▸ **mkdir**(`path`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L13) + +--- + +### readFile + +▸ **readFile**(`path`, `options?`): `Promise`<`string`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`string`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L11) + +--- + +### writeFile + +▸ **writeFile**(`path`, `content`, `options?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------- | :------- | +| `path` | `string` | +| `content` | `string` | +| `options?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:10](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L10) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/LLM.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/LLM.md new file mode 100644 index 0000000000000000000000000000000000000000..40b1354ef1194ace9d87d71f19c8608f668b587d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/LLM.md @@ -0,0 +1,120 @@ +--- +id: "LLM" +title: "Interface: LLM" +sidebar_label: "LLM" +sidebar_position: 0 +custom_edit_url: null +--- + +Unified language model interface + +## Implemented by + +- [`Anthropic`](../classes/Anthropic.md) +- [`LlamaDeuce`](../classes/LlamaDeuce.md) +- [`OpenAI`](../classes/OpenAI.md) +- [`Portkey`](../classes/Portkey.md) + +## Properties + +### hasStreaming + +• **hasStreaming**: `boolean` + +#### Defined in + +[packages/core/src/llm/LLM.ts:68](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L68) + +--- + +### metadata + +• **metadata**: [`LLMMetadata`](LLMMetadata.md) + +#### Defined in + +[packages/core/src/llm/LLM.ts:66](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L66) + +## Methods + +### chat + +▸ **chat**<`T`, `R`\>(`messages`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a chat response from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------ | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :-------------------------------- | :----------------------------------------------------------------------------------------------- | +| `messages` | [`ChatMessage`](ChatMessage.md)[] | The return type of chat() and complete() are set by the "streaming" parameter being set to True. | +| `parentEvent?` | [`Event`](Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:75](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L75) + +--- + +### complete + +▸ **complete**<`T`, `R`\>(`prompt`, `parentEvent?`, `streaming?`): `Promise`<`R`\> + +Get a prompt completion from the LLM + +#### Type parameters + +| Name | Type | +| :--- | :------------------------------------------------------------------------------------------------------ | +| `T` | extends `undefined` \| `boolean` = `undefined` | +| `R` | `T` extends `true` ? `AsyncGenerator`<`string`, `void`, `unknown`\> : [`ChatResponse`](ChatResponse.md) | + +#### Parameters + +| Name | Type | Description | +| :------------- | :------------------ | :--------------------- | +| `prompt` | `string` | the prompt to complete | +| `parentEvent?` | [`Event`](Event.md) | - | +| `streaming?` | `T` | - | + +#### Returns + +`Promise`<`R`\> + +#### Defined in + +[packages/core/src/llm/LLM.ts:88](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L88) + +--- + +### tokens + +▸ **tokens**(`messages`): `number` + +Calculates the number of tokens needed for the given chat messages + +#### Parameters + +| Name | Type | +| :--------- | :-------------------------------- | +| `messages` | [`ChatMessage`](ChatMessage.md)[] | + +#### Returns + +`number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:100](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L100) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/LLMMetadata.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/LLMMetadata.md new file mode 100644 index 0000000000000000000000000000000000000000..6b1d14451ba32d177e246bb1518bcdeb04736c68 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/LLMMetadata.md @@ -0,0 +1,67 @@ +--- +id: "LLMMetadata" +title: "Interface: LLMMetadata" +sidebar_label: "LLMMetadata" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### contextWindow + +• **contextWindow**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L58) + +--- + +### maxTokens + +• `Optional` **maxTokens**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:57](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L57) + +--- + +### model + +• **model**: `string` + +#### Defined in + +[packages/core/src/llm/LLM.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L54) + +--- + +### temperature + +• **temperature**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L55) + +--- + +### tokenizer + +• **tokenizer**: `undefined` \| [`CL100K_BASE`](../enums/Tokenizers.md#cl100k_base) + +#### Defined in + +[packages/core/src/llm/LLM.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L59) + +--- + +### topP + +• **topP**: `number` + +#### Defined in + +[packages/core/src/llm/LLM.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/llm/LLM.ts#L56) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MessageContentDetail.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MessageContentDetail.md new file mode 100644 index 0000000000000000000000000000000000000000..1e49ec1831ddec7e8d6f16efb746f923531553e1 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MessageContentDetail.md @@ -0,0 +1,43 @@ +--- +id: "MessageContentDetail" +title: "Interface: MessageContentDetail" +sidebar_label: "MessageContentDetail" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### image_url + +• `Optional` **image_url**: `Object` + +#### Type declaration + +| Name | Type | +| :---- | :------- | +| `url` | `string` | + +#### Defined in + +[packages/core/src/ChatEngine.ts:344](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L344) + +--- + +### text + +• `Optional` **text**: `string` + +#### Defined in + +[packages/core/src/ChatEngine.ts:343](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L343) + +--- + +### type + +• **type**: `"text"` \| `"image_url"` + +#### Defined in + +[packages/core/src/ChatEngine.ts:342](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ChatEngine.ts#L342) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MetadataFilters.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MetadataFilters.md new file mode 100644 index 0000000000000000000000000000000000000000..863ea6fcae60ff8748c3ab63127e6bb92834b074 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MetadataFilters.md @@ -0,0 +1,17 @@ +--- +id: "MetadataFilters" +title: "Interface: MetadataFilters" +sidebar_label: "MetadataFilters" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### filters + +• **filters**: [`ExactMatchFilter`](ExactMatchFilter.md)[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:28](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L28) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MetadataInfo.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MetadataInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..f276206a3eb5aa2377d7bb105b2dbfb5ee069f63 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/MetadataInfo.md @@ -0,0 +1,37 @@ +--- +id: "MetadataInfo" +title: "Interface: MetadataInfo" +sidebar_label: "MetadataInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:40](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L40) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:38](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L38) + +--- + +### type + +• **type**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:39](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L39) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/NodeParser.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/NodeParser.md new file mode 100644 index 0000000000000000000000000000000000000000..095098899a38787651d82b9d299e6e50373212dd --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/NodeParser.md @@ -0,0 +1,37 @@ +--- +id: "NodeParser" +title: "Interface: NodeParser" +sidebar_label: "NodeParser" +sidebar_position: 0 +custom_edit_url: null +--- + +A NodeParser generates Nodes from Documents + +## Implemented by + +- [`SimpleNodeParser`](../classes/SimpleNodeParser.md) + +## Methods + +### getNodesFromDocuments + +▸ **getNodesFromDocuments**(`documents`): [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] + +Generates an array of nodes from an array of documents. + +#### Parameters + +| Name | Type | Description | +| :---------- | :------------------------------------------------------------------ | :------------------------------------ | +| `documents` | [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] | The documents to generate nodes from. | + +#### Returns + +[`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] + +An array of nodes. + +#### Defined in + +[packages/core/src/NodeParser.ts:86](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/NodeParser.ts#L86) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/NodeWithScore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/NodeWithScore.md new file mode 100644 index 0000000000000000000000000000000000000000..e7de621f7dd34353f9a2de17d28c20f8af20d4f4 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/NodeWithScore.md @@ -0,0 +1,35 @@ +--- +id: "NodeWithScore" +title: "Interface: NodeWithScore<T>" +sidebar_label: "NodeWithScore" +sidebar_position: 0 +custom_edit_url: null +--- + +A node with a similarity score + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Properties + +### node + +• **node**: [`BaseNode`](../classes/BaseNode.md)<`T`\> + +#### Defined in + +[packages/core/src/Node.ts:327](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L327) + +--- + +### score + +• `Optional` **score**: `number` + +#### Defined in + +[packages/core/src/Node.ts:328](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L328) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/QueryEngineTool.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/QueryEngineTool.md new file mode 100644 index 0000000000000000000000000000000000000000..7b6c2649327b815c07152e2c3b2db1ac44b1836e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/QueryEngineTool.md @@ -0,0 +1,39 @@ +--- +id: "QueryEngineTool" +title: "Interface: QueryEngineTool" +sidebar_label: "QueryEngineTool" +sidebar_position: 0 +custom_edit_url: null +--- + +A Tool that uses a QueryEngine. + +## Hierarchy + +- [`BaseTool`](BaseTool.md) + + ↳ **`QueryEngineTool`** + +## Properties + +### metadata + +• **metadata**: [`ToolMetadata`](ToolMetadata.md) + +#### Inherited from + +[BaseTool](BaseTool.md).[metadata](BaseTool.md#metadata) + +#### Defined in + +[packages/core/src/Tool.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Tool.ts#L12) + +--- + +### queryEngine + +• **queryEngine**: [`BaseQueryEngine`](BaseQueryEngine.md) + +#### Defined in + +[packages/core/src/Tool.ts:19](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Tool.ts#L19) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RefDocInfo.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RefDocInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..cdaa357bc2ad09c0edabc9abfe87cfb1d790d197 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RefDocInfo.md @@ -0,0 +1,27 @@ +--- +id: "RefDocInfo" +title: "Interface: RefDocInfo" +sidebar_label: "RefDocInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### extraInfo + +• **extraInfo**: `Record`<`string`, `any`\> + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L12) + +--- + +### nodeIds + +• **nodeIds**: `string`[] + +#### Defined in + +[packages/core/src/storage/docStore/types.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/docStore/types.ts#L11) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RelatedNodeInfo.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RelatedNodeInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..a0c564c6a2b3e9cfb3b207aaefeae70b5a1c0498 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RelatedNodeInfo.md @@ -0,0 +1,53 @@ +--- +id: "RelatedNodeInfo" +title: "Interface: RelatedNodeInfo<T>" +sidebar_label: "RelatedNodeInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Type parameters + +| Name | Type | +| :--- | :-------------------------------------------------------------- | +| `T` | extends [`Metadata`](../#metadata) = [`Metadata`](../#metadata) | + +## Properties + +### hash + +• `Optional` **hash**: `string` + +#### Defined in + +[packages/core/src/Node.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L33) + +--- + +### metadata + +• **metadata**: `T` + +#### Defined in + +[packages/core/src/Node.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L32) + +--- + +### nodeId + +• **nodeId**: `string` + +#### Defined in + +[packages/core/src/Node.ts:30](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L30) + +--- + +### nodeType + +• `Optional` **nodeType**: [`ObjectType`](../enums/ObjectType.md) + +#### Defined in + +[packages/core/src/Node.ts:31](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Node.ts#L31) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RetrievalCallbackResponse.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RetrievalCallbackResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..ffb1ffdb4eee2a8a4005cdfb23069e310a68d508 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/RetrievalCallbackResponse.md @@ -0,0 +1,47 @@ +--- +id: "RetrievalCallbackResponse" +title: "Interface: RetrievalCallbackResponse" +sidebar_label: "RetrievalCallbackResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseCallbackResponse` + + ↳ **`RetrievalCallbackResponse`** + +## Properties + +### event + +• **event**: [`Event`](Event.md) + +#### Inherited from + +BaseCallbackResponse.event + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L20) + +--- + +### nodes + +• **nodes**: [`NodeWithScore`](NodeWithScore.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L65) + +--- + +### query + +• **query**: `string` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L64) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContext.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContext.md new file mode 100644 index 0000000000000000000000000000000000000000..92b4830d0f0c77b4f898b4fa5b93c6f5c5043598 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContext.md @@ -0,0 +1,59 @@ +--- +id: "ServiceContext" +title: "Interface: ServiceContext" +sidebar_label: "ServiceContext" +sidebar_position: 0 +custom_edit_url: null +--- + +The ServiceContext is a collection of components that are used in different parts of the application. + +## Properties + +### callbackManager + +• **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L15) + +--- + +### embedModel + +• **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L13) + +--- + +### llm + +• **llm**: [`LLM`](LLM.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L11) + +--- + +### nodeParser + +• **nodeParser**: [`NodeParser`](NodeParser.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:14](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L14) + +--- + +### promptHelper + +• **promptHelper**: [`PromptHelper`](../classes/PromptHelper.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L12) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContextOptions.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContextOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..fc5095bf7aa1c3994cd17f59a72ead583ae8e5e4 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ServiceContextOptions.md @@ -0,0 +1,77 @@ +--- +id: "ServiceContextOptions" +title: "Interface: ServiceContextOptions" +sidebar_label: "ServiceContextOptions" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### callbackManager + +• `Optional` **callbackManager**: [`CallbackManager`](../classes/CallbackManager.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:24](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L24) + +--- + +### chunkOverlap + +• `Optional` **chunkOverlap**: `number` + +#### Defined in + +[packages/core/src/ServiceContext.ts:27](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L27) + +--- + +### chunkSize + +• `Optional` **chunkSize**: `number` + +#### Defined in + +[packages/core/src/ServiceContext.ts:26](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L26) + +--- + +### embedModel + +• `Optional` **embedModel**: [`BaseEmbedding`](../classes/BaseEmbedding.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:22](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L22) + +--- + +### llm + +• `Optional` **llm**: [`LLM`](LLM.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L20) + +--- + +### nodeParser + +• `Optional` **nodeParser**: [`NodeParser`](NodeParser.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:23](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L23) + +--- + +### promptHelper + +• `Optional` **promptHelper**: [`PromptHelper`](../classes/PromptHelper.md) + +#### Defined in + +[packages/core/src/ServiceContext.ts:21](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/ServiceContext.ts#L21) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StorageContext.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StorageContext.md new file mode 100644 index 0000000000000000000000000000000000000000..be6c7ea1ccc5aafabc98f7aad56e6bc5f4c4054e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StorageContext.md @@ -0,0 +1,37 @@ +--- +id: "StorageContext" +title: "Interface: StorageContext" +sidebar_label: "StorageContext" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### docStore + +• **docStore**: [`BaseDocumentStore`](../classes/BaseDocumentStore.md) + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:11](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/StorageContext.ts#L11) + +--- + +### indexStore + +• **indexStore**: [`BaseIndexStore`](../classes/BaseIndexStore.md) + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:12](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/StorageContext.ts#L12) + +--- + +### vectorStore + +• **vectorStore**: [`VectorStore`](VectorStore.md) + +#### Defined in + +[packages/core/src/storage/StorageContext.ts:13](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/StorageContext.ts#L13) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StreamCallbackResponse.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StreamCallbackResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..21e3c3a5d1ae73e144dc08ee1c7cbfa6e28f1e8a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StreamCallbackResponse.md @@ -0,0 +1,57 @@ +--- +id: "StreamCallbackResponse" +title: "Interface: StreamCallbackResponse" +sidebar_label: "StreamCallbackResponse" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- `BaseCallbackResponse` + + ↳ **`StreamCallbackResponse`** + +## Properties + +### event + +• **event**: [`Event`](Event.md) + +#### Inherited from + +BaseCallbackResponse.event + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:20](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L20) + +--- + +### index + +• **index**: `number` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:58](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L58) + +--- + +### isDone + +• `Optional` **isDone**: `boolean` + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:59](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L59) + +--- + +### token + +• `Optional` **token**: [`DefaultStreamToken`](DefaultStreamToken.md) + +#### Defined in + +[packages/core/src/callbacks/CallbackManager.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/callbacks/CallbackManager.ts#L60) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StructuredOutput.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StructuredOutput.md new file mode 100644 index 0000000000000000000000000000000000000000..e26a7fb1f66308d503659854e470889f5a05203a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/StructuredOutput.md @@ -0,0 +1,35 @@ +--- +id: "StructuredOutput" +title: "Interface: StructuredOutput<T>" +sidebar_label: "StructuredOutput" +sidebar_position: 0 +custom_edit_url: null +--- + +StructuredOutput is just a combo of the raw output and the parsed output. + +## Type parameters + +| Name | +| :--- | +| `T` | + +## Properties + +### parsedOutput + +• **parsedOutput**: `T` + +#### Defined in + +[packages/core/src/OutputParser.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L16) + +--- + +### rawOutput + +• **rawOutput**: `string` + +#### Defined in + +[packages/core/src/OutputParser.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/OutputParser.ts#L15) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/SubQuestion.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/SubQuestion.md new file mode 100644 index 0000000000000000000000000000000000000000..40a446dec75d94c185cf131744a9ac55d3350211 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/SubQuestion.md @@ -0,0 +1,27 @@ +--- +id: "SubQuestion" +title: "Interface: SubQuestion" +sidebar_label: "SubQuestion" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### subQuestion + +• **subQuestion**: `string` + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:15](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L15) + +--- + +### toolName + +• **toolName**: `string` + +#### Defined in + +[packages/core/src/QuestionGenerator.ts:16](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/QuestionGenerator.ts#L16) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ToolMetadata.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ToolMetadata.md new file mode 100644 index 0000000000000000000000000000000000000000..8b18517d0dd423856ed189a23363882f5613832c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/ToolMetadata.md @@ -0,0 +1,27 @@ +--- +id: "ToolMetadata" +title: "Interface: ToolMetadata" +sidebar_label: "ToolMetadata" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### description + +• **description**: `string` + +#### Defined in + +[packages/core/src/Tool.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Tool.ts#L4) + +--- + +### name + +• **name**: `string` + +#### Defined in + +[packages/core/src/Tool.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/Tool.ts#L5) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStore.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStore.md new file mode 100644 index 0000000000000000000000000000000000000000..431a2f9edf1f5d91744fb728e7a3c69bb59c8cc9 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStore.md @@ -0,0 +1,108 @@ +--- +id: "VectorStore" +title: "Interface: VectorStore" +sidebar_label: "VectorStore" +sidebar_position: 0 +custom_edit_url: null +--- + +## Implemented by + +- [`MongoDBAtlasVectorSearch`](../classes/MongoDBAtlasVectorSearch.md) +- [`SimpleVectorStore`](../classes/SimpleVectorStore.md) + +## Properties + +### isEmbeddingQuery + +• `Optional` **isEmbeddingQuery**: `boolean` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:61](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L61) + +--- + +### storesText + +• **storesText**: `boolean` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:60](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L60) + +## Methods + +### add + +▸ **add**(`embeddingResults`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :----------------- | :------------------------------------------------------------------ | +| `embeddingResults` | [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:63](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L63) + +--- + +### client + +▸ **client**(): `any` + +#### Returns + +`any` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:62](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L62) + +--- + +### delete + +▸ **delete**(`refDocId`, `deleteOptions?`): `Promise`<`void`\> + +#### Parameters + +| Name | Type | +| :--------------- | :------- | +| `refDocId` | `string` | +| `deleteOptions?` | `any` | + +#### Returns + +`Promise`<`void`\> + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:64](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L64) + +--- + +### query + +▸ **query**(`query`, `options?`): `Promise`<[`VectorStoreQueryResult`](VectorStoreQueryResult.md)\> + +#### Parameters + +| Name | Type | +| :--------- | :---------------------------------------- | +| `query` | [`VectorStoreQuery`](VectorStoreQuery.md) | +| `options?` | `any` | + +#### Returns + +`Promise`<[`VectorStoreQueryResult`](VectorStoreQueryResult.md)\> + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:65](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L65) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreInfo.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..7c7cc22ede3683fbf27a834f5c4fe27dc4cf5485 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreInfo.md @@ -0,0 +1,27 @@ +--- +id: "VectorStoreInfo" +title: "Interface: VectorStoreInfo" +sidebar_label: "VectorStoreInfo" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### contentInfo + +• **contentInfo**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:45](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L45) + +--- + +### metadataInfo + +• **metadataInfo**: [`MetadataInfo`](MetadataInfo.md)[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:44](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L44) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuery.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuery.md new file mode 100644 index 0000000000000000000000000000000000000000..9a0a79f1de25e84a7e2c32a6e236cab273099385 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuery.md @@ -0,0 +1,87 @@ +--- +id: "VectorStoreQuery" +title: "Interface: VectorStoreQuery" +sidebar_label: "VectorStoreQuery" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### alpha + +• `Optional` **alpha**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:54](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L54) + +--- + +### docIds + +• `Optional` **docIds**: `string`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:51](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L51) + +--- + +### filters + +• `Optional` **filters**: [`MetadataFilters`](MetadataFilters.md) + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:55](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L55) + +--- + +### mmrThreshold + +• `Optional` **mmrThreshold**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:56](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L56) + +--- + +### mode + +• **mode**: [`VectorStoreQueryMode`](../enums/VectorStoreQueryMode.md) + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:53](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L53) + +--- + +### queryEmbedding + +• `Optional` **queryEmbedding**: `number`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:49](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L49) + +--- + +### queryStr + +• `Optional` **queryStr**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:52](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L52) + +--- + +### similarityTopK + +• **similarityTopK**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:50](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L50) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQueryResult.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQueryResult.md new file mode 100644 index 0000000000000000000000000000000000000000..8adc6e186d24d584b45e3656dd316e57f6e2c26e --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQueryResult.md @@ -0,0 +1,37 @@ +--- +id: "VectorStoreQueryResult" +title: "Interface: VectorStoreQueryResult" +sidebar_label: "VectorStoreQueryResult" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### ids + +• **ids**: `string`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:6](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L6) + +--- + +### nodes + +• `Optional` **nodes**: [`BaseNode`](../classes/BaseNode.md)<[`Metadata`](../#metadata)\>[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:4](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L4) + +--- + +### similarities + +• **similarities**: `number`[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:5](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L5) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuerySpec.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuerySpec.md new file mode 100644 index 0000000000000000000000000000000000000000..3bc12c77e24084ecf625d0355bdc38b94280331f --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/VectorStoreQuerySpec.md @@ -0,0 +1,37 @@ +--- +id: "VectorStoreQuerySpec" +title: "Interface: VectorStoreQuerySpec" +sidebar_label: "VectorStoreQuerySpec" +sidebar_position: 0 +custom_edit_url: null +--- + +## Properties + +### filters + +• **filters**: [`ExactMatchFilter`](ExactMatchFilter.md)[] + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:33](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L33) + +--- + +### query + +• **query**: `string` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:32](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L32) + +--- + +### topK + +• `Optional` **topK**: `number` + +#### Defined in + +[packages/core/src/storage/vectorStore/types.ts:34](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/vectorStore/types.ts#L34) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/WalkableFileSystem.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/WalkableFileSystem.md new file mode 100644 index 0000000000000000000000000000000000000000..a25b5bd3214be6e2ab4acc9e7ca42987644ab718 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/WalkableFileSystem.md @@ -0,0 +1,47 @@ +--- +id: "WalkableFileSystem" +title: "Interface: WalkableFileSystem" +sidebar_label: "WalkableFileSystem" +sidebar_position: 0 +custom_edit_url: null +--- + +## Methods + +### readdir + +▸ **readdir**(`path`): `Promise`<`string`[]\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`string`[]\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:17](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L17) + +--- + +### stat + +▸ **stat**(`path`): `Promise`<`any`\> + +#### Parameters + +| Name | Type | +| :----- | :------- | +| `path` | `string` | + +#### Returns + +`Promise`<`any`\> + +#### Defined in + +[packages/core/src/storage/FileSystem.ts:18](https://github.com/run-llama/LlamaIndexTS/blob/3552de1/packages/core/src/storage/FileSystem.ts#L18) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..43bec88cfa0aadb0e46f28701aad493dec3f2097 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api/interfaces/_category_.yml @@ -0,0 +1,2 @@ +label: "Interfaces" +position: 4 \ No newline at end of file diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts.md new file mode 100644 index 0000000000000000000000000000000000000000..69b8d49756bf23dee935aad9ee22d6525b70ed8a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/concepts.md @@ -0,0 +1,78 @@ +--- +sidebar_position: 3 +--- + +# 高层次概念 + +LlamaIndex.TS 帮助您构建基于自定义数据的LLM(例如问答、聊天机器人)应用程序。 + +在这份高层次概念指南中,您将学习: + +- LLM如何使用您自己的数据回答问题。 +- LlamaIndex.TS中用于组合您自己的查询管道的关键概念和模块。 + +## 跨您的数据回答问题 + +LlamaIndex使用两阶段方法结合您的数据使用LLM: + +1. **索引阶段**:准备知识库, +2. **查询阶段**:从知识中检索相关上下文以协助LLM回答问题 + + + +这个过程也被称为检索增强生成(Retrieval Augmented Generation,RAG)。 + +LlamaIndex.TS提供了必要的工具包,使这两个步骤变得非常简单。 + +让我们详细探索每个阶段。 + +### 索引阶段 + +LlamaIndex.TS 通过一系列数据连接器和索引帮助您准备知识库。 + + + +[**数据加载器**](./modules/high_level/data_loader.md): +数据连接器(即 `Reader`)从不同的数据源和数据格式摄取数据,转换成简单的 `Document` 表示(文本和简单元数据)。 + +[**文档 / 节点**](./modules/high_level/documents_and_nodes.md): `Document` 是围绕任何数据源的通用容器 - 例如,PDF、API 输出,或从数据库检索的数据。`Node` 是 LlamaIndex 中数据的原子单位,代表源 `Document` 的一个“块”。它是一个丰富的表示,包括元数据和关系(与其他节点),以实现准确和表达性的检索操作。 + +[**数据索引**](./modules/high_level/data_index.md): +一旦您摄取了数据,LlamaIndex 将帮助您将数据索引成易于检索的格式。 + +在底层,LlamaIndex 解析原始文档为中间表示,计算向量嵌入,并将您的数据存储在内存或磁盘上。 + +### 查询阶段 + +在查询阶段,查询管道检索给定用户查询的最相关上下文, +并将其(连同查询)传递给LLM以合成响应。 + +这为LLM提供了最新的知识,这些知识不在其原始训练数据中, +(同时减少幻觉现象)。 + +查询阶段的关键挑战是检索、协调和推理(可能很多)知识库。 + +LlamaIndex提供了可组合的模块,帮助您构建和集成RAG管道,用于问答(查询引擎 Query Engine),聊天机器人(聊天引擎 Chat Engine),或作为代理的一部分。 + +这些构建块可以定制以反映排名偏好,也可以组合以结构化地推理多个知识库。 + + + +#### 构建模块 + +[**检索器**](./modules/low_level/retriever.md): +检索器定义了如何在给定查询时从知识库(即索引)中高效检索相关上下文。 +具体的检索逻辑对于不同的索引有所不同,最流行的是对向量索引进行密集检索。 + +[**响应合成器**](./modules/low_level/response_synthesizer.md): +响应合成器使用用户查询和一组给定的检索文本块,从LLM生成响应。 + +#### 管道 + +[**查询引擎**](./modules/high_level/query_engine.md): +查询引擎是一个端到端的管道,允许您通过数据提出问题。 +它接收自然语言查询,并返回响应,连同检索到的参考上下文一起传递给LLM。 + +[**聊天引擎**](./modules/high_level/chat_engine.md): +聊天引擎是一个端到端的管道,用于与您的数据进行对话 +(多次来回而不是单个问题和答案)。 diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/end_to_end.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/end_to_end.md new file mode 100644 index 0000000000000000000000000000000000000000..5cf19cb266e9b9e076582bbf1793682cdc3fa280 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/end_to_end.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 4 +--- + +# 端到端示例 + +我们在仓库中包含了使用 LlamaIndex.TS 的几个端到端示例 + +请查看下面的示例,或者通过 Dev-Docs 提供的交互式 Github Codespace 教程在几分钟内尝试并完成它们[这里](https://codespaces.new/team-dev-docs/lits-dev-docs-playground?devcontainer_path=.devcontainer%2Fjavascript_ltsquickstart%2Fdevcontainer.json): + +## [聊天引擎 (Chat Engine)](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/chatEngine.ts) + +读取一个文件并与 LLM 聊天。 + +## [向量索引](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndex.ts) + +创建一个向量索引并查询它。向量索引将使用嵌入来获取最相关的前 k 个节点。默认情况下,前 k 为 2。 + +## [摘要索引](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/summaryIndex.ts) + +创建一个列表索引并查询它。这个示例还使用了 `LLMRetriever`,它将利用 LLM 选择最佳节点来生成答案时使用。 + +## [保存 / 加载索引](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/storageContext.ts) + +创建并加载向量索引。在 LlamaIndex.TS 中,一旦创建了存储上下文对象,数据持久化到磁盘就会自动进行。 + +## [自定义向量索引](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/vectorIndexCustomize.ts) + +创建一个向量索引并查询它,同时配置 `LLM`、`ServiceContext` 和 `similarity_top_k`。 + +## [OpenAI LLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/openai.ts) + +创建一个 OpenAI LLM 并直接用于聊天。 + +## [Llama2 DeuceLLM](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/llamadeuce.ts) + +创建一个 Llama-2 LLM 并直接用于聊天。 + +## [SubQuestionQueryEngine](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts) + +使用 `SubQuestionQueryEngine`(子问题查询引擎),它将复杂的查询分解成多个问题,然后跨所有子问题的答案聚合响应。 + +## [低级模块 (Low Level Modules)](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/lowlevel.ts) + +此示例使用了几个低级组件,这消除了对实际查询引擎的需求。这些组件可以在任何地方、任何应用程序中使用,或者自定义和子类化以满足您自己的需求。 diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/environments.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/environments.md new file mode 100644 index 0000000000000000000000000000000000000000..0e5da1a23f99824f372add181dbf375dd812bd80 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/environments.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 5 +--- + +# 环境 + +LlamaIndex 目前官方支持 NodeJS 18 和 NodeJS 20。 + +## NextJS 应用路由器 + +如果您正在使用 NextJS 应用路由器的路由处理程序/无服务器函数,您将需要使用 NodeJS 模式: + +```js +export const runtime = "nodejs"; // 默认 +``` + +并且您需要在 next.config.js 中为 pdf-parse 添加一个例外 + +```js +// next.config.js +/** @type {import('next').NextConfig} */ +const nextConfig = { + experimental: { + serverComponentsExternalPackages: ["pdf-parse"], // 将 pdf-parse 置于实际的 NodeJS 模式与 NextJS 应用路由器 + }, +}; + +module.exports = nextConfig; +``` diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/installation.mdx b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/installation.mdx new file mode 100644 index 0000000000000000000000000000000000000000..988da60009ac91e98caed2dde7b7bba99bab4373 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/installation.mdx @@ -0,0 +1,69 @@ +--- +sidebar_position: 1 +--- + + +# 安装与设置 + +确保你的 NodeJS 版本为 v18 或更高。 + + + +## 使用 create-llama + +使用 `create-llama` 是开始构建 LlamaIndex 应用的最简单方法。这个 CLI 工具能让你快速开始一个新的 LlamaIndex 应用,所有设置都为你准备好了。 + +只需运行 + +<Tabs> +<TabItem value="1" label="npm" default> + +```bash +npx create-llama@latest +``` + +</TabItem> +<TabItem value="2" label="Yarn"> + +```bash +yarn create llama +``` + +</TabItem> +<TabItem value="3" label="pnpm"> + +```bash +pnpm create llama@latest +``` + +</TabItem> +</Tabs> + +即可开始。一旦你的应用生成后,运行 + +```bash npm2yarn +npm run dev +``` + +来启动开发服务器。然后你可以访问 [http://localhost:3000](http://localhost:3000) 来查看你的应用。 + +## 通过 NPM 安装 + +```bash npm2yarn +npm install llamaindex +``` + + + +### 环境变量 + +我们的示例默认使用 OpenAI。你需要像这样设置你的 OpenAI 密钥: + +```bash +export OPENAI_API_KEY="sk-......" # 请替换为你从 https://platform.openai.com/account/api-keys 获取的密钥 +``` + +如果你想要每次自动加载它,将其添加到你的 .zshrc/.bashrc 文件中。 + +警告:不要将你的 OpenAI 密钥提交到版本控制中。 + diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.md new file mode 100644 index 0000000000000000000000000000000000000000..d93b0e34fb1339037df34561dee1aafe0802be9a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/introduction.md @@ -0,0 +1,56 @@ +--- +sidebar_position: 0 +slug: / +--- + +# 什么是 LlamaIndex.TS? + +LlamaIndex.TS 是一个数据框架,用于LLM应用程序摄取、结构化和访问私有或特定领域的数据。虽然也提供了Python包(参见[这里](https://docs.llamaindex.ai/en/stable/)),但LlamaIndex.TS提供了一些核心功能,在一个简单的包中,为TypeScript的使用进行了优化。 + +## 🚀 为什么选择 LlamaIndex.TS? + +从本质上讲,LLM提供了人类与推断数据之间的自然语言接口。广泛可用的模型预先训练了大量公开可用的数据,包括维基百科、邮件列表、教科书和源代码。 + +基于LLM构建的应用程序通常需要用私有或特定领域的数据增强这些模型。不幸的是,这些数据可能分布在孤立的应用程序和数据存储中。它们可能隐藏在API后面,存储在SQL数据库中,或者被困在PDF和幻灯片中。 + +这就是 **LlamaIndex.TS** 发挥作用的地方。 + +## 🦙 LlamaIndex.TS 能提供哪些帮助? + +LlamaIndex.TS 提供以下工具: + +- **数据加载** 直接摄取您现有的 `.txt`、`.pdf`、`.csv`、`.md` 和 `.docx` 数据 +- **数据索引** 将您的数据结构化为中间表示,这些表示对LLMs来说易于消费且性能优越。 +- **引擎** 为您的数据提供自然语言访问。例如: + - 查询引擎(Query engines)是强大的检索界面,用于知识增强输出。 + - 聊天引擎(Chat engines)是对话式界面,用于与您的数据进行多消息的“来回”互动。 + +## 👨👩👧👦 谁适合使用 LlamaIndex? + +LlamaIndex.TS 提供了一套核心工具,对于任何使用JavaScript和TypeScript构建LLM应用程序的人来说都是必不可少的。 + +我们的高级API允许初级用户使用LlamaIndex.TS来摄取和查询他们的数据。 + +对于更复杂的应用程序,我们的低级API允许高级用户自定义和扩展任何模块——数据连接器、索引、检索器和查询引擎,以适应他们的需求。 + +## 入门 + +`npm install llamaindex` + +我们的文档包括[安装说明](./installation.md)和一个[入门教程](./starter.md),帮助你构建第一个应用程序。 + +一旦你开始运行,[高级概念](./concepts.md)有一个LlamaIndex模块化架构的概览。更多实践例子,请浏览我们的[端到端教程](./end_to_end.md)。 + +## 🗺️ 生态系统 + +要下载或贡献,请在以下位置找到LlamaIndex: + +- Github: https://github.com/run-llama/LlamaIndexTS +- NPM: https://www.npmjs.com/package/llamaindex + +## 社区 + +需要帮助?有功能建议?加入LlamaIndex社区: + +- Twitter: https://twitter.com/llama_index +- Discord: https://discord.gg/dGcwcsnxhU diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..8b70105f3ce366526dac9feaa5a674461ac5e4dd --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/_category_.yml @@ -0,0 +1,3 @@ +label: "Modules" +collapsed: false +position: 5 diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..57933784bafc5c6ab729a5ee2716d1fe16a843ec --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/_category_.yml @@ -0,0 +1 @@ +label: High-Level Modules diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md new file mode 100644 index 0000000000000000000000000000000000000000..21a95652d2b0d327bd9af859e3f205ce53148014 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/chat_engine.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 4 +--- + +# 聊天引擎 (ChatEngine) + +聊天引擎是一种快速简单的方式,用于与索引中的数据进行聊天。 + +```typescript +const retriever = index.asRetriever(); +const chatEngine = new ContextChatEngine({ retriever }); + +// 开始聊天 +const response = await chatEngine.chat(query); +``` + +## API 参考 + +- [ContextChatEngine](../../api/classes/ContextChatEngine.md) +- [CondenseQuestionChatEngine](../../api/classes/ContextChatEngine.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md new file mode 100644 index 0000000000000000000000000000000000000000..97359028026d80f823e6f1416186dfe73aeff27d --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/data_index.md @@ -0,0 +1,25 @@ +--- +sidebar_position: 2 +--- + +# 索引 + +索引是您数据的基本容器和组织方式。LlamaIndex.TS 支持两种索引: + +- `VectorStoreIndex` - 在生成响应时会向LLM发送前k个`Node`。默认的前k值是2。 +- `SummaryIndex` - 在生成响应时会将索引中的每个`Node`发送给LLM + +```typescript +import { Document, VectorStoreIndex } from "llamaindex"; + +const document = new Document({ text: "test" }); + +const index = await VectorStoreIndex.fromDocuments([document]); +``` + +## API 参考 + +- [SummaryIndex](../../api/classes/SummaryIndex.md) +- [VectorStoreIndex](../../api/classes/VectorStoreIndex.md) + +" diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md new file mode 100644 index 0000000000000000000000000000000000000000..bdf7879708bda1e3071f54f4d90a24e9f81094e6 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/data_loader.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 1 +--- + +# 读取器 / 加载器 + +LlamaIndex.TS 支持使用 `SimpleDirectoryReader` 类从文件夹中轻松加载文件。目前支持 `.txt`、`.pdf`、`.csv`、`.md` 和 `.docx` 文件,未来计划支持更多格式! + +```typescript +import { SimpleDirectoryReader } from "llamaindex"; + +documents = new SimpleDirectoryReader().loadData("./data"); +``` + +## API 参考 + +- [SimpleDirectoryReader](../../api/classes/SimpleDirectoryReader.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md new file mode 100644 index 0000000000000000000000000000000000000000..571fe2fd3f75ca9e22f0e6b8c8a0a93c430b45c6 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/documents_and_nodes.md @@ -0,0 +1,18 @@ +--- +sidebar_position: 0 +--- + +# 文档和节点 + +`Document`(文档)和`Node`(节点)是任何索引的基本构建块。虽然这些对象的 API 相似,但`Document`对象代表整个文件,而`Node`则是原始文档的较小部分,适合用于LLM和Q&A。 + +```typescript +import { Document } from "llamaindex"; + +document = new Document({ text: "text", metadata: { key: "val" } }); +``` + +## API 参考 + +- [Document](../../api/classes/Document.md) +- [TextNode](../../api/classes/TextNode.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md new file mode 100644 index 0000000000000000000000000000000000000000..657d30dcf69fb656943b82f04313d4a2f67cf532 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/high_level/query_engine.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 3 +--- + +# 查询引擎 (QueryEngine) + +查询引擎将一个`Retriever`和一个`ResponseSynthesizer`封装成一个流水线,该流水线将使用查询字符串来获取节点,然后将它们发送到LLM以生成响应。 + +```typescript +const queryEngine = index.asQueryEngine(); +const response = await queryEngine.query("查询字符串"); +``` + +## 子问题查询引擎 (Sub Question Query Engine) + +子问题查询引擎的基本概念是将单个查询分割成多个查询,为每个查询获取答案,然后将这些不同的答案合并成一个为用户提供的连贯响应。你可以将其视为“逐步思考”提示技术,但是在你的数据源上进行迭代! + +### 入门 + +开始尝试子问题查询引擎最简单的方法是运行[examples](https://github.com/run-llama/LlamaIndexTS/blob/main/examples/subquestion.ts)中的subquestion.ts文件。 + +```bash +npx ts-node subquestion.ts +``` + +### 工具 (Tools) + +SubQuestionQueryEngine是通过工具(Tools)来实现的。工具的基本思想是它们是大型语言模型的可执行选项。在这种情况下,我们的SubQuestionQueryEngine依赖于QueryEngineTool,正如你猜到的,它是一个在查询引擎上运行查询的工具。这使我们能够给模型一个选项,例如,为不同的问题查询不同的文档。你也可以想象,SubQuestionQueryEngine可能使用一个工具在网上搜索某些东西,或者使用Wolfram Alpha获取答案。 + +你可以通过查看LlamaIndex Python文档了解更多关于工具的信息 https://gpt-index.readthedocs.io/en/latest/core_modules/agent_modules/tools/root.html + +## API 参考 + +- [RetrieverQueryEngine](../../api/classes/RetrieverQueryEngine.md) +- [SubQuestionQueryEngine](../../api/classes/SubQuestionQueryEngine.md) +- [QueryEngineTool](../../api/interfaces/QueryEngineTool.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/index.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/index.md new file mode 100644 index 0000000000000000000000000000000000000000..ec9a76512e0342dc71b4675ec38fb3ccf296e11a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/index.md @@ -0,0 +1,31 @@ +# 核心模块 + +LlamaIndex.TS 提供了几个核心模块,分为高级模块以便快速开始使用,以及低级模块以便根据需要自定义关键组件。 + +## 高级模块 + +- [**文档**](./high_level/documents_and_nodes.md):文档代表一个文本文件、PDF文件或其他连续的数据片段。 + +- [**节点**](./high_level/documents_and_nodes.md):基本的数据构建块。通常,这些是被分割成可管理的小块的文档部分,小到足以被输入到嵌入模型和LLM中。 + +- [**读取器/加载器**](./high_level/data_loader.md):读取器或加载器是将现实世界中的文档转换成可以在您的索引和查询中使用的文档类的东西。我们目前支持纯文本文件和PDF,未来将支持更多格式。 + +- [**索引**](./high_level/data_index.md):索引存储节点及其嵌入。 + +- [**查询引擎 (QueryEngine)**](./high_level/query_engine.md):查询引擎是生成您输入的查询并返回结果的工具。查询引擎通常结合预构建的提示与您索引中选定的节点,为LLM提供回答您查询所需的上下文。 + +- [**聊天引擎 (ChatEngine)**](./high_level/chat_engine.md):聊天引擎帮助您构建一个将与您的索引互动的聊天机器人。 + +## 低级模块 + +- [**LLM**](./low_level/llm.md): LLM 类是一个统一的接口,适用于如 OpenAI GPT-4、Anthropic Claude 或 Meta LLaMA 等大型语言模型提供商。您可以子类化它以编写连接到您自己的大型语言模型的连接器。 + +- [**嵌入(Embedding)**](./low_level/embedding.md): 嵌入表示为一个浮点数向量。OpenAI 的 text-embedding-ada-002 是我们默认的嵌入模型,它生成的每个嵌入包含 1,536 个浮点数。另一个流行的嵌入模型是 BERT,它使用 768 个浮点数来表示每个节点。我们提供了许多工具来处理嵌入,包括 3 种相似度计算选项和最大边际相关性。 + +- [**文本分割器/节点解析器(TextSplitter/NodeParser)**](./low_level/node_parser.md): 文本分割策略对于嵌入搜索的整体效果非常重要。目前,虽然我们有一个默认值,但并没有一种适合所有情况的解决方案。根据源文档,您可能希望使用不同的分割大小和策略。目前我们支持按固定大小分割、按固定大小带重叠部分分割、按句子分割和按段落分割。文本分割器在将 `Document` 分割成 `Node` 时被节点解析器使用。 + +- [**检索器(Retriever)**](./low_level/retriever.md): 检索器实际上是从索引中选择要检索的节点的工具。在这里,您可能希望尝试检索更多或更少的节点每个查询,更改您的相似度函数,或为您应用中的每个个别用例创建自己的检索器。例如,您可能希望为代码内容与文本内容有不同的检索器。 + +- [**响应合成器(ResponseSynthesizer)**](./low_level/response_synthesizer.md): 响应合成器负责接受一个查询字符串,并使用一系列 `Node` 生成响应。这可以采取多种形式,如遍历所有上下文并精炼答案,或构建一个摘要树并返回根摘要。 + +- [**存储(Storage)**](./low_level/storage.md): 在某个时刻,您将希望存储您的索引、数据和向量,而不是每次都重新运行嵌入模型。IndexStore、DocStore、VectorStore 和 KVStore 是让您能够做到这一点的抽象。它们合在一起形成了 StorageContext。目前,我们允许您在文件系统上(或虚拟的内存文件系统中)的文件中持久化您的嵌入,但我们也在积极添加对向量数据库的集成。 diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/_category_.yml b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/_category_.yml new file mode 100644 index 0000000000000000000000000000000000000000..263a37cba6e5593614475f5764ec6762e236d018 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/_category_.yml @@ -0,0 +1 @@ +label: Low-Level Modules diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/embedding.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/embedding.md new file mode 100644 index 0000000000000000000000000000000000000000..214c9d5f90689b4ab46dfd00dd4d715a7718555c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/embedding.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 1 +--- + +# 嵌入 + +LlamaIndex中的嵌入模型负责创建文本的数值表示。默认情况下,LlamaIndex将使用OpenAI的`text-embedding-ada-002`模型。 + +这可以在`ServiceContext`对象中明确设置。 + +```typescript +import { OpenAIEmbedding, serviceContextFromDefaults } from "llamaindex"; + +const openaiEmbeds = new OpenAIEmbedding(); + +const serviceContext = serviceContextFromDefaults({ embedModel: openaiEmbeds }); +``` + +## API 参考 + +- [OpenAIEmbedding](../../api/classes/OpenAIEmbedding.md) +- [ServiceContext](../../api/interfaces/ServiceContext.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/llm.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/llm.md new file mode 100644 index 0000000000000000000000000000000000000000..a05cb543dbdd823b66d3b44f4d3da1e5f27add8c --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/llm.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 0 +--- + +# LLM + +LLM 负责读取文本并生成对查询的自然语言响应。默认情况下,LlamaIndex.TS 使用 `gpt-3.5-turbo`。 + +可以在 `ServiceContext` 对象中明确设置 LLM。 + +```typescript +import { OpenAI, serviceContextFromDefaults } from "llamaindex"; + +const openaiLLM = new OpenAI({ model: "gpt-3.5-turbo", temperature: 0 }); + +const serviceContext = serviceContextFromDefaults({ llm: openaiLLM }); +``` + +## API 参考 + +- [OpenAI](../../api/classes/OpenAI.md) +- [ServiceContext](../../api/interfaces/ServiceContext.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/node_parser.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/node_parser.md new file mode 100644 index 0000000000000000000000000000000000000000..94a38c0c65cac07c1eb2f63a5e6e963cb9ad5f60 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/node_parser.md @@ -0,0 +1,33 @@ +--- +sidebar_position: 3 +--- + +# NodeParser 节点解析器 + +`NodeParser` 在 LlamaIndex 中负责将 `Document` 对象拆分成更易管理的 `Node` 对象。当你调用 `.fromDocuments()` 时,`ServiceContext` 中的 `NodeParser` 会自动为你完成这个操作。或者,你也可以提前使用它来拆分文档。 + +```typescript +import { Document, SimpleNodeParser } from "llamaindex"; + +const nodeParser = new SimpleNodeParser(); +const nodes = nodeParser.getNodesFromDocuments([ + new Document({ text: "I am 10 years old. John is 20 years old." }), +]); +``` + +## TextSplitter 文本分割器 + +底层的文本分割器会按句子来分割文本。它也可以作为一个独立模块用于分割原始文本。 + +```typescript +import { SentenceSplitter } from "llamaindex"; + +const splitter = new SentenceSplitter({ chunkSize: 1 }); + +const textSplits = splitter.splitText("Hello World"); +``` + +## API 参考 + +- [SimpleNodeParser](../../api/classes/SimpleNodeParser.md) +- [SentenceSplitter](../../api/classes/SentenceSplitter.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/response_synthesizer.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/response_synthesizer.md new file mode 100644 index 0000000000000000000000000000000000000000..d9df17ddcd523b84d06a30f0d2821701b4bfcacd --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/response_synthesizer.md @@ -0,0 +1,44 @@ +--- +sidebar_position: 6 +--- + +# 响应合成器 (ResponseSynthesizer) + +响应合成器负责将查询、节点和提示模板发送到LLM以生成响应。生成响应有几种关键模式: + +- `Refine`:通过顺序处理每个检索到的文本块来“创建并完善”答案。 + 这会对每个节点进行单独的LLM调用。适合更详细的答案。 +- `CompactAndRefine`(默认):通过在每次LLM调用中“压缩”提示,将尽可能多的文本块塞入最大提示大小内。如果有太多块无法一次性塞入提示中,则通过处理多个压缩提示来“创建并完善”答案。与`refine`相同,但应该会导致更少的LLM调用。 +- `TreeSummarize`:给定一组文本块和查询,递归构建一棵树,并返回根节点作为响应。适合总结目的。 +- `SimpleResponseBuilder`:给定一组文本块和查询,将查询应用于每个文本块,同时将响应累积到一个数组中。返回所有响应的连接字符串。适用于需要对每个文本块分别运行相同查询的情况。 + +```typescript +import { NodeWithScore, ResponseSynthesizer, TextNode } from "llamaindex"; + +const responseSynthesizer = new ResponseSynthesizer(); + +const nodesWithScore: NodeWithScore[] = [ + { + node: new TextNode({ text: "我今年10岁。" }), + score: 1, + }, + { + node: new TextNode({ text: "约翰今年20岁。" }), + score: 0.5, + }, +]; + +const response = await responseSynthesizer.synthesize( + "我几岁了?", + nodesWithScore, +); +console.log(response.response); +``` + +## API 参考 + +- [响应合成器 (ResponseSynthesizer)](../../api/classes/ResponseSynthesizer.md) +- [精炼 (Refine)](../../api/classes/Refine.md) +- [压缩并精炼 (CompactAndRefine)](../../api/classes/CompactAndRefine.md) +- [树状总结 (TreeSummarize)](../../api/classes/TreeSummarize.md) +- [简单响应构建器 (SimpleResponseBuilder)](../../api/classes/SimpleResponseBuilder.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md new file mode 100644 index 0000000000000000000000000000000000000000..183705617b416a8e3d0e32253ad1c85a3f9cd2c3 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/retriever.md @@ -0,0 +1,21 @@ +--- +sidebar_position: 5 +--- + +# 检索器 + +在LlamaIndex中,检索器用于使用查询字符串从索引中获取`Node`。`VectorIndexRetriever`将获取最相似的前k个节点。同时,`SummaryIndexRetriever`将获取所有节点,不管查询内容如何。 + +```typescript +const retriever = vector_index.asRetriever(); +retriever.similarityTopK = 3; + +// 获取节点! +const nodesWithScore = await retriever.retrieve("查询字符串"); +``` + +## API 参考 + +- [SummaryIndexRetriever](../../api/classes/SummaryIndexRetriever.md) +- [SummaryIndexLLMRetriever](../../api/classes/SummaryIndexLLMRetriever.md) +- [VectorIndexRetriever](../../api/classes/VectorIndexRetriever.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/storage.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/storage.md new file mode 100644 index 0000000000000000000000000000000000000000..d19051ccbddb6deef98ce85af45d7eda93e1f90a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/modules/low_level/storage.md @@ -0,0 +1,27 @@ +--- +sidebar_position: 7 +--- + +# 存储 + +在配置了 `StorageContext` 对象后,LlamaIndex.TS 中的存储功能会自动工作。只需配置 `persistDir` 并将其附加到索引上。 + +目前,只支持从磁盘保存和加载数据,未来计划支持更多集成! + +```typescript +import { Document, VectorStoreIndex, storageContextFromDefaults } from "./src"; + +// 默认设置创建存储上下文 +const storageContext = await storageContextFromDefaults({ + persistDir: "./storage", // 持久化目录 +}); + +const document = new Document({ text: "Test Text" }); // 创建文档 +const index = await VectorStoreIndex.fromDocuments([document], { + storageContext, // 使用存储上下文 +}); +``` + +## API 参考 + +- [StorageContext](../../api/interfaces/StorageContext.md) diff --git a/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/starter.md b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/starter.md new file mode 100644 index 0000000000000000000000000000000000000000..71e7d990d22c5ae9c047e3806223261a420a48e9 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/starter.md @@ -0,0 +1,54 @@ +--- +sidebar_position: 2 +--- + +# 入门教程 + +一旦你已经[使用NPM安装了LlamaIndex.TS](installation)并设置了你的OpenAI密钥,你就可以开始你的第一个应用了: + +在一个新文件夹中: + +```bash npm2yarn +npm install typescript +npm install @types/node +npx tsc --init # 如有必要 +``` + +创建文件 `example.ts`。这段代码将加载一些示例数据,创建一个文档,对其进行索引(这将使用OpenAI创建嵌入),然后创建查询引擎以回答有关数据的问题。 + +```ts +// example.ts +import fs from "fs/promises"; +import { Document, VectorStoreIndex } from "llamaindex"; + +async function main() { + // 在Node中从abramov.txt加载文章 + const essay = await fs.readFile( + "node_modules/llamaindex/examples/abramov.txt", + "utf-8", + ); + + // 使用文章创建Document对象 + const document = new Document({ text: essay }); + + // 分割文本并创建嵌入。将它们存储在VectorStoreIndex中 + const index = await VectorStoreIndex.fromDocuments([document]); + + // 查询索引 + const queryEngine = index.asQueryEngine(); + const response = await queryEngine.query("作者在大学中做了什么?"); + + // 输出响应 + console.log(response.toString()); +} + +main(); +``` + +然后你可以使用以下命令运行它 + +```bash +npx ts-node example.ts +``` + +准备好了解更多吗?请查看我们的NextJS游乐场 https://llama-playground.vercel.app/。源代码可在 https://github.com/run-llama/ts-playground 获取。 diff --git a/apps/docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json b/apps/docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json new file mode 100644 index 0000000000000000000000000000000000000000..5c1683f2dbc9d76feadb6ac84f01c459a709176a --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json @@ -0,0 +1,34 @@ +{ + "link.title.Docs": { + "message": "Docs", + "description": "The title of the footer links column with title=Docs in the footer" + }, + "link.title.Community": { + "message": "Community", + "description": "The title of the footer links column with title=Community in the footer" + }, + "link.title.More": { + "message": "More", + "description": "The title of the footer links column with title=More in the footer" + }, + "link.item.label.API": { + "message": "API", + "description": "The label of footer link with label=API linking to /api" + }, + "link.item.label.Discord": { + "message": "Discord", + "description": "The label of footer link with label=Discord linking to https://discord.com/invite/eN6D2HQ4aX" + }, + "link.item.label.Twitter": { + "message": "Twitter", + "description": "The label of footer link with label=Twitter linking to https://twitter.com/LlamaIndex" + }, + "link.item.label.GitHub": { + "message": "GitHub", + "description": "The label of footer link with label=GitHub linking to https://github.com/run-llama/LlamaIndexTS" + }, + "copyright": { + "message": "Copyright © 2023 LlamaIndex. Built with Docusaurus.", + "description": "The footer copyright" + } +} diff --git a/apps/docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json b/apps/docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json new file mode 100644 index 0000000000000000000000000000000000000000..65e001e220ffd0939fe844eda2cb0fa72a765d78 --- /dev/null +++ b/apps/docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json @@ -0,0 +1,18 @@ +{ + "title": { + "message": "LlamaIndex.TS", + "description": "The title in the navbar" + }, + "logo.alt": { + "message": "LlamaIndex.TS", + "description": "The alt text of navbar logo" + }, + "item.label.Docs": { + "message": "Docs", + "description": "Navbar item with label Docs" + }, + "item.label.GitHub": { + "message": "GitHub", + "description": "Navbar item with label GitHub" + } +} diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index 68018edd2f931fb4e11a2e14cec0505c0f61e6da..5d95aaf613027dab0a6b6ed6333cbe2b3a31b406 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,15 @@ # llamaindex +## 0.0.38 + +### Patch Changes + +- 786c25d: Fixes to the PGVectorStore (thanks @mtutty) +- bf9e263: Azure bugfix (thanks @parhammmm) +- bf9e263: AssemblyAI updates (thanks @Swimburger) +- 786c25d: Add GPT-4 Vision support (thanks @marcusschiesser) +- bf9e263: Internationalization of docs (thanks @hexapode and @disiok) + ## 0.0.37 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index 50be7acbcad33fdf1ceb357210f7bb2b95bd74ac..39763d032a2ddae7187d00f65ec99fa6a2cd09b4 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,12 +1,12 @@ { "name": "llamaindex", - "version": "0.0.37", + "version": "0.0.38", "license": "MIT", "dependencies": { "@anthropic-ai/sdk": "^0.9.1", "@datastax/astra-db-ts": "^0.1.0", - "@notionhq/client": "^2.2.13", - "@xenova/transformers": "^2.8.0", + "@notionhq/client": "^2.2.14", + "@xenova/transformers": "^2.10.0", "assemblyai": "^3.1.3", "crypto-js": "^4.2.0", "js-tiktoken": "^1.0.8", @@ -15,7 +15,7 @@ "md-utils-ts": "^2.0.0", "mongodb": "^6.3.0", "notion-md-crawler": "^0.0.2", - "openai": "^4.20.0", + "openai": "^4.20.1", "papaparse": "^5.4.1", "pdf-parse": "^1.1.1", "pg": "^8.11.3", @@ -30,10 +30,10 @@ "devDependencies": { "@types/crypto-js": "^4.2.1", "@types/lodash": "^4.14.202", - "@types/node": "^18.18.12", - "@types/papaparse": "^5.3.13", + "@types/node": "^18.19.2", + "@types/papaparse": "^5.3.14", "@types/pdf-parse": "^1.1.4", - "@types/pg": "^8.10.7", + "@types/pg": "^8.10.9", "@types/uuid": "^9.0.7", "node-stdlib-browser": "^1.2.0", "tsup": "^7.2.0", diff --git a/packages/core/src/llm/LLM.ts b/packages/core/src/llm/LLM.ts index 7ebc7bca5333f2a182d1dfa2e90d6c5783ea69ab..95442beb63f4844cd9a57f0a28a7ab06b7cc1205 100644 --- a/packages/core/src/llm/LLM.ts +++ b/packages/core/src/llm/LLM.ts @@ -337,6 +337,8 @@ export class OpenAI implements LLM { //Indices var idx_counter: number = 0; for await (const part of chunk_stream) { + if (!part.choices.length) continue; + //Increment part.choices[0].index = idx_counter; const is_done: boolean = diff --git a/packages/create-llama/CHANGELOG.md b/packages/create-llama/CHANGELOG.md index 2e77301d1e1da401b6fbaa3a8d235af97d8e3f1c..faa128b0d2cee3e7de6625ac553076bf43ee5d2e 100644 --- a/packages/create-llama/CHANGELOG.md +++ b/packages/create-llama/CHANGELOG.md @@ -1,5 +1,13 @@ # create-llama +## 0.0.11 + +### Patch Changes + +- 2aeb341: - Added option to create a new project based on community templates + - Added OpenAI model selector for NextJS projects + - Added GPT4 Vision support (and file upload) + ## 0.0.10 ### Patch Changes diff --git a/packages/create-llama/package.json b/packages/create-llama/package.json index b0b063914ee35526341b2dad48768ebfffeecf01..f69cb026374920048a3f67f7674795fa05f14722 100644 --- a/packages/create-llama/package.json +++ b/packages/create-llama/package.json @@ -1,6 +1,6 @@ { "name": "create-llama", - "version": "0.0.10", + "version": "0.0.11", "keywords": [ "rag", "llamaindex", diff --git a/packages/create-llama/templates/types/simple/express/package.json b/packages/create-llama/templates/types/simple/express/package.json index 55902071463959a02df82ad72ae516d0e385bc78..849261e4a23743e193c97b3482be5b45f6e7f1f4 100644 --- a/packages/create-llama/templates/types/simple/express/package.json +++ b/packages/create-llama/templates/types/simple/express/package.json @@ -11,17 +11,17 @@ "dependencies": { "cors": "^2.8.5", "dotenv": "^16.3.1", - "express": "^4", - "llamaindex": "0.0.31" + "express": "^4.18.2", + "llamaindex": "0.0.37" }, "devDependencies": { - "@types/cors": "^2.8.16", - "@types/express": "^4", - "@types/node": "^20", - "concurrently": "^8", - "eslint": "^8", - "nodemon": "^3", - "tsup": "^7", - "typescript": "^5" + "@types/cors": "^2.8.17", + "@types/express": "^4.17.21", + "@types/node": "^20.9.5", + "concurrently": "^8.2.2", + "eslint": "^8.54.0", + "nodemon": "^3.0.1", + "tsup": "^7.3.0", + "typescript": "^5.3.2" } } diff --git a/packages/create-llama/templates/types/streaming/express/package.json b/packages/create-llama/templates/types/streaming/express/package.json index 6af064a8b6915055d556271119335ee341cec65f..3e46bb5fb2b427e7d7b1f4cc62b5334aa72437da 100644 --- a/packages/create-llama/templates/types/streaming/express/package.json +++ b/packages/create-llama/templates/types/streaming/express/package.json @@ -9,20 +9,20 @@ "dev": "concurrently \"tsup index.ts --format esm --dts --watch\" \"nodemon -q dist/index.js\"" }, "dependencies": { - "ai": "^2.2.5", + "ai": "^2.2.25", "cors": "^2.8.5", "dotenv": "^16.3.1", - "express": "^4", - "llamaindex": "0.0.31" + "express": "^4.18.2", + "llamaindex": "0.0.37" }, "devDependencies": { "@types/cors": "^2.8.16", - "@types/express": "^4", - "@types/node": "^20", - "concurrently": "^8", - "eslint": "^8", - "nodemon": "^3", - "tsup": "^7", - "typescript": "^5" + "@types/express": "^4.17.21", + "@types/node": "^20.9.5", + "concurrently": "^8.2.2", + "eslint": "^8.54.0", + "nodemon": "^3.0.1", + "tsup": "^8.0.1", + "typescript": "^5.3.2" } -} \ No newline at end of file +} diff --git a/packages/create-llama/templates/types/streaming/nextjs/package.json b/packages/create-llama/templates/types/streaming/nextjs/package.json index fc68725d40560fa6b68a9757dcf1c5e22f193dc1..3160e53c098029b9eb476aa0b54741d1904bdaa1 100644 --- a/packages/create-llama/templates/types/streaming/nextjs/package.json +++ b/packages/create-llama/templates/types/streaming/nextjs/package.json @@ -15,7 +15,7 @@ "dotenv": "^16.3.1", "llamaindex": "0.0.37", "lucide-react": "^0.294.0", - "next": "^13.5.6", + "next": "^14.0.3", "react": "^18.2.0", "react-dom": "^18.2.0", "react-markdown": "^8.0.7", @@ -33,7 +33,7 @@ "@types/react-dom": "^18.2.17", "autoprefixer": "^10.4.16", "eslint": "^8.55.0", - "eslint-config-next": "^13.5.6", + "eslint-config-next": "^14.0.3", "postcss": "^8.4.32", "tailwindcss": "^3.3.6", "typescript": "^5.3.2", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index f33b441a5af6c5bc5dd95837c6e21f4587baa5ed..079de736ae46d5bb6af79677bb4773e12547620a 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -17,7 +17,7 @@ importers: version: 2.26.2 '@turbo/gen': specifier: ^1.10.16 - version: 1.10.16(@types/node@18.18.12)(typescript@5.3.2) + version: 1.10.16(@types/node@20.10.3)(typescript@5.3.2) '@types/jest': specifier: ^29.5.10 version: 29.5.10 @@ -32,7 +32,7 @@ importers: version: 8.0.3 jest: specifier: ^29.7.0 - version: 29.7.0(@types/node@18.18.12) + version: 29.7.0(@types/node@20.10.3) lint-staged: specifier: ^15.1.0 version: 15.1.0 @@ -56,7 +56,7 @@ importers: version: 2.4.3(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) '@docusaurus/preset-classic': specifier: 2.4.3 - version: 2.4.3(@algolia/client-search@4.20.0)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.10.0)(typescript@4.9.5) + version: 2.4.3(@algolia/client-search@4.20.0)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.11.0)(typescript@4.9.5) '@docusaurus/remark-plugin-npm2yarn': specifier: ^2.4.3 version: 2.4.3 @@ -144,11 +144,11 @@ importers: specifier: ^0.1.0 version: 0.1.0 '@notionhq/client': - specifier: ^2.2.13 - version: 2.2.13 + specifier: ^2.2.14 + version: 2.2.14 '@xenova/transformers': - specifier: ^2.8.0 - version: 2.8.0 + specifier: ^2.10.0 + version: 2.10.0 assemblyai: specifier: ^3.1.3 version: 3.1.3 @@ -174,8 +174,8 @@ importers: specifier: ^0.0.2 version: 0.0.2 openai: - specifier: ^4.20.0 - version: 4.20.0 + specifier: ^4.20.1 + version: 4.20.1 papaparse: specifier: ^5.4.1 version: 5.4.1 @@ -214,16 +214,16 @@ importers: specifier: ^4.14.202 version: 4.14.202 '@types/node': - specifier: ^18.18.12 - version: 18.18.12 + specifier: ^18.19.2 + version: 18.19.2 '@types/papaparse': - specifier: ^5.3.13 - version: 5.3.13 + specifier: ^5.3.14 + version: 5.3.14 '@types/pdf-parse': specifier: ^1.1.4 version: 1.1.4 '@types/pg': - specifier: ^8.10.7 + specifier: ^8.10.9 version: 8.10.9 '@types/uuid': specifier: ^9.0.7 @@ -311,16 +311,16 @@ importers: dependencies: eslint-config-next: specifier: ^13.4.1 - version: 13.4.1(eslint@8.54.0)(typescript@5.3.2) + version: 13.4.1(eslint@8.55.0)(typescript@5.3.2) eslint-config-prettier: specifier: ^8.3.0 - version: 8.8.0(eslint@8.54.0) + version: 8.8.0(eslint@8.55.0) eslint-config-turbo: specifier: ^1.9.3 - version: 1.9.3(eslint@8.54.0) + version: 1.9.3(eslint@8.55.0) eslint-plugin-react: specifier: 7.28.0 - version: 7.28.0(eslint@8.54.0) + version: 7.28.0(eslint@8.55.0) devDependencies: next: specifier: ^13.4.10 @@ -334,10 +334,10 @@ packages: resolution: {integrity: sha512-1Yjs2SvM8TflER/OD3cOjhWWOZb58A2t7wpE2S9XfBYTiIl+XFhQG2bjy4Pu1I+EAlCNUzRDYDdFwFYUKvXcIA==} engines: {node: '>=0.10.0'} - /@algolia/autocomplete-core@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.10.0): + /@algolia/autocomplete-core@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.11.0): resolution: {integrity: sha512-009HdfugtGCdC4JdXUbVJClA0q0zh24yyePn+KUGk3rP7j8FEe/m5Yo/z65gn6nP/cM39PxpzqKrL7A6fP6PPw==} dependencies: - '@algolia/autocomplete-plugin-algolia-insights': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.10.0) + '@algolia/autocomplete-plugin-algolia-insights': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.11.0) '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) transitivePeerDependencies: - '@algolia/client-search' @@ -345,13 +345,13 @@ packages: - search-insights dev: false - /@algolia/autocomplete-plugin-algolia-insights@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.10.0): + /@algolia/autocomplete-plugin-algolia-insights@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.11.0): resolution: {integrity: sha512-a/yTUkcO/Vyy+JffmAnTWbr4/90cLzw+CC3bRbhnULr/EM0fGNvM13oQQ14f2moLMcVDyAx/leczLlAOovhSZg==} peerDependencies: search-insights: '>= 1 < 3' dependencies: '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) - search-insights: 2.10.0 + search-insights: 2.11.0 transitivePeerDependencies: - '@algolia/client-search' - algoliasearch @@ -482,7 +482,7 @@ packages: /@anthropic-ai/sdk@0.9.1: resolution: {integrity: sha512-wa1meQ2WSfoY8Uor3EdrJq0jTiZJoKoSii2ZVWRY1oN4Tlr5s59pADg9T79FTbPe1/se5c3pBeZgJL63wmuoBA==} dependencies: - '@types/node': 18.18.12 + '@types/node': 18.19.2 '@types/node-fetch': 2.6.9 abort-controller: 3.0.0 agentkeepalive: 4.5.0 @@ -2327,7 +2327,7 @@ packages: resolution: {integrity: sha512-SPiDHaWKQZpwR2siD0KQUwlStvIAnEyK6tAE2h2Wuoq8ue9skzhlyVQ1ddzOxX6khULnAALDiR/isSF3bnuciA==} dev: false - /@docsearch/react@3.5.2(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.10.0): + /@docsearch/react@3.5.2(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.11.0): resolution: {integrity: sha512-9Ahcrs5z2jq/DcAvYtvlqEBHImbm4YJI8M9y0x6Tqg598P40HTEkX7hsMcIuThI+hTFxRGZ9hll0Wygm2yEjng==} peerDependencies: '@types/react': '>= 16.8.0 < 19.0.0' @@ -2344,13 +2344,13 @@ packages: search-insights: optional: true dependencies: - '@algolia/autocomplete-core': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.10.0) + '@algolia/autocomplete-core': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.11.0) '@algolia/autocomplete-preset-algolia': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) '@docsearch/css': 3.5.2 algoliasearch: 4.20.0 react: 17.0.2 react-dom: 17.0.2(react@17.0.2) - search-insights: 2.10.0 + search-insights: 2.11.0 transitivePeerDependencies: - '@algolia/client-search' dev: false @@ -2815,7 +2815,7 @@ packages: - webpack-cli dev: false - /@docusaurus/preset-classic@2.4.3(@algolia/client-search@4.20.0)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.10.0)(typescript@4.9.5): + /@docusaurus/preset-classic@2.4.3(@algolia/client-search@4.20.0)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.11.0)(typescript@4.9.5): resolution: {integrity: sha512-tRyMliepY11Ym6hB1rAFSNGwQDpmszvWYJvlK1E+md4SW8i6ylNHtpZjaYFff9Mdk3i/Pg8ItQq9P0daOJAvQw==} engines: {node: '>=16.14'} peerDependencies: @@ -2833,7 +2833,7 @@ packages: '@docusaurus/plugin-sitemap': 2.4.3(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) '@docusaurus/theme-classic': 2.4.3(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) '@docusaurus/theme-common': 2.4.3(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) - '@docusaurus/theme-search-algolia': 2.4.3(@algolia/client-search@4.20.0)(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.10.0)(typescript@4.9.5) + '@docusaurus/theme-search-algolia': 2.4.3(@algolia/client-search@4.20.0)(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.11.0)(typescript@4.9.5) '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) react: 17.0.2 react-dom: 17.0.2(react@17.0.2) @@ -2973,14 +2973,14 @@ packages: - webpack-cli dev: false - /@docusaurus/theme-search-algolia@2.4.3(@algolia/client-search@4.20.0)(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.10.0)(typescript@4.9.5): + /@docusaurus/theme-search-algolia@2.4.3(@algolia/client-search@4.20.0)(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.11.0)(typescript@4.9.5): resolution: {integrity: sha512-jziq4f6YVUB5hZOB85ELATwnxBz/RmSLD3ksGQOLDPKVzat4pmI8tddNWtriPpxR04BNT+ZfpPUMFkNFetSW1Q==} engines: {node: '>=16.14'} peerDependencies: react: ^16.8.4 || ^17.0.0 react-dom: ^16.8.4 || ^17.0.0 dependencies: - '@docsearch/react': 3.5.2(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.10.0) + '@docsearch/react': 3.5.2(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.11.0) '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) '@docusaurus/logger': 2.4.3 '@docusaurus/plugin-content-docs': 2.4.3(eslint@8.54.0)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) @@ -3334,6 +3334,16 @@ packages: eslint: 8.54.0 eslint-visitor-keys: 3.4.3 + /@eslint-community/eslint-utils@4.4.0(eslint@8.55.0): + resolution: {integrity: sha512-1/sA4dwrzBAyeUoQ6oxahHKmrZvsnLCg4RfxW3ZFGGmQkSNQPFNLV9CUEFQP1x9EYXHTo5p6xdhZM1Ne9p/AfA==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + peerDependencies: + eslint: ^6.0.0 || ^7.0.0 || >=8.0.0 + dependencies: + eslint: 8.55.0 + eslint-visitor-keys: 3.4.3 + dev: false + /@eslint-community/regexpp@4.10.0: resolution: {integrity: sha512-Cu96Sd2By9mCNTx2iyKOmq10v22jUVQv0lQnlGNy16oE9589yE+QADPbrMGCkA51cKZSg3Pu/aTJVTGfL/qjUA==} engines: {node: ^12.0.0 || ^14.0.0 || >=16.0.0} @@ -3354,10 +3364,32 @@ packages: transitivePeerDependencies: - supports-color + /@eslint/eslintrc@2.1.4: + resolution: {integrity: sha512-269Z39MS6wVJtsoUl10L60WdkhJVdPG24Q4eZTH3nnF6lpvSShEK3wQjDX9JRWAUPvPh7COouPpU9IrqaZFvtQ==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + dependencies: + ajv: 6.12.6 + debug: 4.3.4 + espree: 9.6.1 + globals: 13.23.0 + ignore: 5.3.0 + import-fresh: 3.3.0 + js-yaml: 4.1.0 + minimatch: 3.1.2 + strip-json-comments: 3.1.1 + transitivePeerDependencies: + - supports-color + dev: false + /@eslint/js@8.54.0: resolution: {integrity: sha512-ut5V+D+fOoWPgGGNj83GGjnntO39xDy6DWxO0wb7Jp3DcMX0TfIqdzHF85VTQkerdyGmuuMD9AKAo5KiNlf/AQ==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + /@eslint/js@8.55.0: + resolution: {integrity: sha512-qQfo2mxH5yVom1kacMtZZJFVdW+E70mqHMJvVg6WTLo+VBuQJ4TojZlfWBjK0ve5BdEeNAVxOsl/nvNMpJOaJA==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + dev: false + /@hapi/hoek@9.3.0: resolution: {integrity: sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==} @@ -3404,7 +3436,7 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 chalk: 4.1.2 jest-message-util: 29.7.0 jest-util: 29.7.0 @@ -3425,14 +3457,14 @@ packages: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 ansi-escapes: 4.3.2 chalk: 4.1.2 ci-info: 3.9.0 exit: 0.1.2 graceful-fs: 4.2.11 jest-changed-files: 29.7.0 - jest-config: 29.7.0(@types/node@18.18.12) + jest-config: 29.7.0(@types/node@20.10.3) jest-haste-map: 29.7.0 jest-message-util: 29.7.0 jest-regex-util: 29.6.3 @@ -3460,7 +3492,7 @@ packages: dependencies: '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 jest-mock: 29.7.0 dev: true @@ -3487,7 +3519,7 @@ packages: dependencies: '@jest/types': 29.6.3 '@sinonjs/fake-timers': 10.3.0 - '@types/node': 18.18.12 + '@types/node': 20.10.3 jest-message-util: 29.7.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -3520,7 +3552,7 @@ packages: '@jest/transform': 29.7.0 '@jest/types': 29.6.3 '@jridgewell/trace-mapping': 0.3.20 - '@types/node': 18.18.12 + '@types/node': 20.10.3 chalk: 4.1.2 collect-v8-coverage: 1.0.2 exit: 0.1.2 @@ -3607,7 +3639,7 @@ packages: '@jest/schemas': 29.6.3 '@types/istanbul-lib-coverage': 2.0.6 '@types/istanbul-reports': 3.0.4 - '@types/node': 18.18.12 + '@types/node': 20.10.3 '@types/yargs': 17.0.31 chalk: 4.1.2 @@ -3836,6 +3868,16 @@ packages: - encoding dev: false + /@notionhq/client@2.2.14: + resolution: {integrity: sha512-oqUefZtCiJPCX+74A1Os9OVTef3fSnVWe2eVQtU1HJSD+nsfxfhwvDKnzJTh2Tw1ZHKLxpieHB/nzGdY+Uo12A==} + engines: {node: '>=12'} + dependencies: + '@types/node-fetch': 2.6.9 + node-fetch: 2.7.0(encoding@0.1.13) + transitivePeerDependencies: + - encoding + dev: false + /@pinecone-database/pinecone@1.1.2: resolution: {integrity: sha512-xrvaMWWloTjT70pSxvw+Es2f7qX5lzhtTZBfduagtwGQqK0nFMqS6Jq+1yqzobDaUhqfRfVwRZ95Gm10odqD3Q==} engines: {node: '>=14.0.0'} @@ -4163,7 +4205,7 @@ packages: resolution: {integrity: sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==} dev: true - /@turbo/gen@1.10.16(@types/node@18.18.12)(typescript@5.3.2): + /@turbo/gen@1.10.16(@types/node@20.10.3)(typescript@5.3.2): resolution: {integrity: sha512-PzyluADjVuy5OcIi+/aRcD70OElQpRVRDdfZ9fH8G5Fv75lQcNrjd1bBGKmhjSw+g+eTEkXMGnY7s6gsCYjYTQ==} hasBin: true dependencies: @@ -4175,7 +4217,7 @@ packages: minimatch: 9.0.3 node-plop: 0.26.3 proxy-agent: 6.3.1 - ts-node: 10.9.1(@types/node@18.18.12)(typescript@5.3.2) + ts-node: 10.9.1(@types/node@20.10.3)(typescript@5.3.2) update-check: 1.5.4 validate-npm-package-name: 5.0.0 transitivePeerDependencies: @@ -4243,13 +4285,13 @@ packages: resolution: {integrity: sha512-oyl4jvAfTGX9Bt6Or4H9ni1Z447/tQuxnZsytsCaExKlmJiU8sFgnIBRzJUpKwB5eWn9HuBYlUlVA74q/yN0eQ==} dependencies: '@types/connect': 3.4.36 - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/bonjour@3.5.11: resolution: {integrity: sha512-isGhjmBtLIxdHBDl2xGwUzEM8AOyOvWsADWq7rqirdi/ZQoHnLWErHvsThcEzTX8juDRiZtzp2Qkv5bgNh6mAg==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/cacheable-request@6.0.3: @@ -4257,7 +4299,7 @@ packages: dependencies: '@types/http-cache-semantics': 4.0.4 '@types/keyv': 3.1.4 - '@types/node': 18.18.12 + '@types/node': 20.9.0 '@types/responselike': 1.0.3 dev: true @@ -4269,19 +4311,19 @@ packages: resolution: {integrity: sha512-iaQslNbARe8fctL5Lk+DsmgWOM83lM+7FzP0eQUJs1jd3kBE8NWqBTIT2S8SqQOJjxvt2eyIjpOuYeRXq2AdMw==} dependencies: '@types/express-serve-static-core': 4.17.37 - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/connect@3.4.36: resolution: {integrity: sha512-P63Zd/JUGq+PdrM1lv0Wv5SBYeA2+CORvbrXbngriYY0jzLUWfQMQQxOhjONEz/wlHOAxOdY7CY65rgQdTjq2w==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/cross-spawn@6.0.0: resolution: {integrity: sha512-evp2ZGsFw9YKprDbg8ySgC9NA15g3YgiI8ANkGmKKvvi0P2aDGYLPxQIC5qfeKNUOe3TjABVGuah6omPRpIYhg==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.9.0 dev: true /@types/crypto-js@4.2.1: @@ -4297,7 +4339,7 @@ packages: /@types/eslint-scope@3.7.7: resolution: {integrity: sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==} dependencies: - '@types/eslint': 8.44.7 + '@types/eslint': 8.44.8 '@types/estree': 1.0.5 dev: false @@ -4307,8 +4349,8 @@ packages: '@types/estree': 1.0.2 '@types/json-schema': 7.0.13 - /@types/eslint@8.44.7: - resolution: {integrity: sha512-f5ORu2hcBbKei97U73mf+l9t4zTGl74IqZ0GQk4oVea/VS8tQZYkUveSYojk+frraAVYId0V2WC9O4PTNru2FQ==} + /@types/eslint@8.44.8: + resolution: {integrity: sha512-4K8GavROwhrYl2QXDXm0Rv9epkA8GBFu0EI+XrrnnuCl7u8CWBRusX7fXJfanhZTDWSAL24gDI/UqXyUM0Injw==} dependencies: '@types/estree': 1.0.5 '@types/json-schema': 7.0.15 @@ -4324,7 +4366,7 @@ packages: /@types/express-serve-static-core@4.17.37: resolution: {integrity: sha512-ZohaCYTgGFcOP7u6aJOhY9uIZQgZ2vxC2yWoArY+FeDXlqeH66ZVBjgvg+RLVAS/DWNq4Ap9ZXu1+SUQiiWYMg==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 '@types/qs': 6.9.8 '@types/range-parser': 1.2.5 '@types/send': 0.17.2 @@ -4343,13 +4385,13 @@ packages: resolution: {integrity: sha512-ZUxbzKl0IfJILTS6t7ip5fQQM/J3TJYubDm3nMbgubNNYS62eXeUpoLUC8/7fJNiFYHTrGPQn7hspDUzIHX3UA==} dependencies: '@types/minimatch': 5.1.2 - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: true /@types/graceful-fs@4.1.9: resolution: {integrity: sha512-olP3sd1qOEe5dXTSaFvQG+02VdRXcdytWLAZsAq1PecU8uqQAhkrnbli7DagjtXKW/Bl7YJbUsa8MPcuc8LHEQ==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: true /@types/hast@2.3.6: @@ -4376,7 +4418,7 @@ packages: /@types/http-proxy@1.17.12: resolution: {integrity: sha512-kQtujO08dVtQ2wXAuSFfk9ASy3sug4+ogFR8Kd8UgP8PEuc1/G/8yjYRmp//PcDNJEUKOza/MrQu15bouEUCiw==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/inquirer@6.5.0: @@ -4426,10 +4468,10 @@ packages: /@types/keyv@3.1.4: resolution: {integrity: sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.9.0 - /@types/lodash-es@4.17.10: - resolution: {integrity: sha512-YJP+w/2khSBwbUSFdGsSqmDvmnN3cCKoPOL7Zjle6s30ZtemkkqhjVfFqGwPN7ASil5VyjE2GtyU/yqYY6mC0A==} + /@types/lodash-es@4.17.12: + resolution: {integrity: sha512-0NgftHUcV4v34VhXm8QBSftKVXtbkBG3ViCjs6+eJ5a6y6Mi/jiFGPc1sC7QK+9BFhWrURE3EOggmWaSxL9OzQ==} dependencies: '@types/lodash': 4.14.202 dev: false @@ -4466,7 +4508,7 @@ packages: /@types/node-fetch@2.6.9: resolution: {integrity: sha512-bQVlnMLFJ2d35DkPNjEPmd9ueO/rh5EiaZt2bhqiSarPjZIuIV6bPQVqcrEyvNo+AfTrRGVazle1tl597w3gfA==} dependencies: - '@types/node': 18.18.12 + '@types/node': 18.19.2 form-data: 4.0.0 dev: false @@ -4483,20 +4525,29 @@ packages: dependencies: undici-types: 5.26.5 + /@types/node@18.19.2: + resolution: {integrity: sha512-6wzfBdbWpe8QykUkXBjtmO3zITA0A3FIjoy+in0Y2K4KrCiRhNYJIdwAPDffZ3G6GnaKaSLSEa9ZuORLfEoiwg==} + dependencies: + undici-types: 5.26.5 + + /@types/node@20.10.3: + resolution: {integrity: sha512-XJavIpZqiXID5Yxnxv3RUDKTN5b81ddNC3ecsA0SoFXz/QU8OGBwZGMomiq0zw+uuqbL/krztv/DINAQ/EV4gg==} + dependencies: + undici-types: 5.26.5 + /@types/node@20.9.0: resolution: {integrity: sha512-nekiGu2NDb1BcVofVcEKMIwzlx4NjHlcjhoxxKBNLtz15Y1z7MYf549DFvkHSId02Ax6kGwWntIBPC3l/JZcmw==} dependencies: undici-types: 5.26.5 - dev: true /@types/normalize-package-data@2.4.4: resolution: {integrity: sha512-37i+OaWTh9qeK4LSHPsyRC7NahnGotNuZvjLSgcPzblpHB3rrCJxAOgI5gCdKm7coonsaX1Of0ILiTcnZjbfxA==} dev: true - /@types/papaparse@5.3.13: - resolution: {integrity: sha512-tYSlZI3tIdBHXea8fZHcmwbsd1mSUikdMUyqpqj0Zzfu2GTGUSHEKmcnBg699WJ8UnxG31rXD4b1mLGPOAxS2w==} + /@types/papaparse@5.3.14: + resolution: {integrity: sha512-LxJ4iEFcpqc6METwp9f6BV6VVc43m6MfH0VqFosHvrUgfXiFe6ww7R3itkOQ+TCK6Y+Iv/+RnnvtRZnkc5Kc9g==} dependencies: - '@types/node': 18.18.12 + '@types/node': 18.19.2 dev: true /@types/parse-json@4.0.0: @@ -4514,7 +4565,7 @@ packages: /@types/pg@8.10.9: resolution: {integrity: sha512-UksbANNE/f8w0wOMxVKKIrLCbEMV+oM1uKejmwXr39olg4xqcfBDbXxObJAt6XxHbDa4XTKOlUEcEltXDX+XLQ==} dependencies: - '@types/node': 18.18.12 + '@types/node': 18.19.2 pg-protocol: 1.6.0 pg-types: 4.0.1 dev: true @@ -4564,7 +4615,7 @@ packages: /@types/responselike@1.0.3: resolution: {integrity: sha512-H/+L+UkTV33uf49PH5pCAUBVPNj2nDBXTN+qS1dOwyyg24l3CcicicCA7ca+HMvJBZcFgl5r8e+RR6elsb4Lyw==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.9.0 /@types/retry@0.12.0: resolution: {integrity: sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==} @@ -4577,7 +4628,7 @@ packages: /@types/sax@1.2.5: resolution: {integrity: sha512-9jWta97bBVC027/MShr3gLab8gPhKy4l6qpb+UJLF5pDm3501NvA7uvqVCW+REFtx00oTi6Cq9JzLwgq6evVgw==} dependencies: - '@types/node': 18.18.12 + '@types/node': 17.0.45 dev: false /@types/scheduler@0.16.4: @@ -4591,7 +4642,7 @@ packages: resolution: {integrity: sha512-aAG6yRf6r0wQ29bkS+x97BIs64ZLxeE/ARwyS6wrldMm3C1MdKwCcnnEwMC1slI8wuxJOpiUH9MioC0A0i+GJw==} dependencies: '@types/mime': 1.3.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/serve-index@1.9.2: @@ -4605,13 +4656,13 @@ packages: dependencies: '@types/http-errors': 2.0.2 '@types/mime': 3.0.2 - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/sockjs@0.3.34: resolution: {integrity: sha512-R+n7qBFnm/6jinlteC9DBL5dGiDGjWAvjo4viUanpnc/dG1y7uDoacXPIQ/PQEg1fI912SMHIa014ZjRpvDw4g==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/stack-utils@2.0.3: @@ -4621,14 +4672,14 @@ packages: /@types/tar@6.1.5: resolution: {integrity: sha512-qm2I/RlZij5RofuY7vohTpYNaYcrSQlN2MyjucQc7ZweDwaEWkdN/EeNh6e9zjK6uEm6PwjdMXkcj05BxZdX1Q==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.9.0 minipass: 4.2.8 dev: true /@types/through@0.0.33: resolution: {integrity: sha512-HsJ+z3QuETzP3cswwtzt2vEIiHBk/dCcHGhbmG5X3ecnwFD/lPrMpliGXxSCg03L9AhrdwA4Oz/qfspkDW+xGQ==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: true /@types/tinycolor2@1.4.6: @@ -4664,7 +4715,7 @@ packages: /@types/ws@8.5.6: resolution: {integrity: sha512-8B5EO9jLVCy+B58PLHvLDuOD8DRVMgQzq8d55SjLCOn9kqGyqOvy27exVaTio1q1nX5zLu8/6N0n2ThSxOM6tg==} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 dev: false /@types/yargs-parser@21.0.3: @@ -4675,7 +4726,7 @@ packages: dependencies: '@types/yargs-parser': 21.0.3 - /@typescript-eslint/parser@5.59.2(eslint@8.54.0)(typescript@5.3.2): + /@typescript-eslint/parser@5.59.2(eslint@8.55.0)(typescript@5.3.2): resolution: {integrity: sha512-uq0sKyw6ao1iFOZZGk9F8Nro/8+gfB5ezl1cA06SrqbgJAt0SRoFhb9pXaHvkrxUpZaoLxt8KlovHNk8Gp6/HQ==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} peerDependencies: @@ -4689,7 +4740,7 @@ packages: '@typescript-eslint/types': 5.59.2 '@typescript-eslint/typescript-estree': 5.59.2(typescript@5.3.2) debug: 4.3.4 - eslint: 8.54.0 + eslint: 8.55.0 typescript: 5.3.2 transitivePeerDependencies: - supports-color @@ -4836,8 +4887,8 @@ packages: '@webassemblyjs/ast': 1.11.6 '@xtuc/long': 4.2.2 - /@xenova/transformers@2.8.0: - resolution: {integrity: sha512-+6/cC/iJd7A+B+C3OPuiIw3dhisdUqBRD/f8CAoo2wYfHofF9zn46pH/dTLAOPoI2px7L9+bvJoXSKO18TBj2Q==} + /@xenova/transformers@2.10.0: + resolution: {integrity: sha512-Al9WKiOsimAC3mU9Ef434GkHF0izmeAM7mMMx5npdWsWLAYL8fmJXCrULj6uCfjomMQ7jyN9rDtKpp570hffiw==} dependencies: onnxruntime-web: 1.14.0 sharp: 0.32.6 @@ -5203,7 +5254,7 @@ packages: call-bind: 1.0.5 is-nan: 1.3.2 object-is: 1.1.5 - object.assign: 4.1.4 + object.assign: 4.1.5 util: 0.12.5 dev: true @@ -5688,6 +5739,17 @@ packages: node-releases: 2.0.13 update-browserslist-db: 1.0.13(browserslist@4.22.1) + /browserslist@4.22.2: + resolution: {integrity: sha512-0UgcrvQmBDvZHFGdYUehrCNIazki7/lUP3kkoi/r3YB2amZbFM9J43ZRkJTXBUZK4gmx56+Sqk9+Vs9mwZx9+A==} + engines: {node: ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7} + hasBin: true + dependencies: + caniuse-lite: 1.0.30001566 + electron-to-chromium: 1.4.605 + node-releases: 2.0.14 + update-browserslist-db: 1.0.13(browserslist@4.22.2) + dev: false + /bs-logger@0.2.6: resolution: {integrity: sha512-pd8DCoxmbgc7hyPKOvxtqNcjYoOsABPQdcCUjGp3d42VR2CX1ORhk2A87oqqu5R1kk+76nsxZupkmyd+MVtCog==} engines: {node: '>= 6'} @@ -5884,6 +5946,10 @@ packages: /caniuse-lite@1.0.30001546: resolution: {integrity: sha512-zvtSJwuQFpewSyRrI3AsftF6rM0X80mZkChIt1spBGEvRglCrjTniXvinc8JKRoqTwXAgvqTImaN9igfSMtUBw==} + /caniuse-lite@1.0.30001566: + resolution: {integrity: sha512-ggIhCsTxmITBAMmK8yZjEhCO5/47jKXPu6Dha/wuCS4JePVL+3uiDEBuhu2aIoT+bqTOR8L76Ip1ARL9xYsEJA==} + dev: false + /ccount@1.1.0: resolution: {integrity: sha512-vlNK021QdI7PNeiUh/lKkC/mNHHfV0m/Ad5JoI0TYtlBnJAslM/JIkm/tGC88bkLIwO6OQ5uV6ztS6kVAtCDlg==} dev: false @@ -6485,7 +6551,7 @@ packages: sha.js: 2.4.11 dev: true - /create-jest@29.7.0(@types/node@18.18.12): + /create-jest@29.7.0(@types/node@20.10.3): resolution: {integrity: sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -6494,7 +6560,7 @@ packages: chalk: 4.1.2 exit: 0.1.2 graceful-fs: 4.2.11 - jest-config: 29.7.0(@types/node@18.18.12) + jest-config: 29.7.0(@types/node@20.10.3) jest-util: 29.7.0 prompts: 2.4.2 transitivePeerDependencies: @@ -7272,6 +7338,10 @@ packages: /electron-to-chromium@1.4.543: resolution: {integrity: sha512-t2ZP4AcGE0iKCCQCBx/K2426crYdxD3YU6l0uK2EO3FZH0pbC4pFz/sZm2ruZsND6hQBTcDWWlo/MLpiOdif5g==} + /electron-to-chromium@1.4.605: + resolution: {integrity: sha512-V52j+P5z6cdRqTjPR/bYNxx7ETCHIkm5VIGuyCy3CMrfSnbEpIlLnk5oHmZo7gYvDfh2TfHeanB6rawyQ23ktg==} + dev: false + /elliptic@6.5.4: resolution: {integrity: sha512-iLhC6ULemrljPZb+QutR5TQGB+pdW6KGD5RSegS+8sorOZT+rdQFbsQFJgvN3eRqNALqJer4oQ16YvJHlU8hzQ==} dependencies: @@ -7578,7 +7648,7 @@ packages: source-map: 0.6.1 dev: true - /eslint-config-next@13.4.1(eslint@8.54.0)(typescript@5.3.2): + /eslint-config-next@13.4.1(eslint@8.55.0)(typescript@5.3.2): resolution: {integrity: sha512-ajuxjCkW1hvirr0EQZb3/B/bFH52Z7CT89uCtTcICFL9l30i5c8hN4p0LXvTjdOXNPV5fEDcxBgGHgXdzTj1/A==} peerDependencies: eslint: ^7.23.0 || ^8.0.0 @@ -7589,36 +7659,36 @@ packages: dependencies: '@next/eslint-plugin-next': 13.4.1 '@rushstack/eslint-patch': 1.2.0 - '@typescript-eslint/parser': 5.59.2(eslint@8.54.0)(typescript@5.3.2) - eslint: 8.54.0 + '@typescript-eslint/parser': 5.59.2(eslint@8.55.0)(typescript@5.3.2) + eslint: 8.55.0 eslint-import-resolver-node: 0.3.7 - eslint-import-resolver-typescript: 3.5.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-plugin-import@2.27.5)(eslint@8.54.0) - eslint-plugin-import: 2.27.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-typescript@3.5.5)(eslint@8.54.0) - eslint-plugin-jsx-a11y: 6.7.1(eslint@8.54.0) - eslint-plugin-react: 7.32.2(eslint@8.54.0) - eslint-plugin-react-hooks: 4.6.0(eslint@8.54.0) + eslint-import-resolver-typescript: 3.5.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-plugin-import@2.27.5)(eslint@8.55.0) + eslint-plugin-import: 2.27.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-typescript@3.5.5)(eslint@8.55.0) + eslint-plugin-jsx-a11y: 6.7.1(eslint@8.55.0) + eslint-plugin-react: 7.32.2(eslint@8.55.0) + eslint-plugin-react-hooks: 4.6.0(eslint@8.55.0) typescript: 5.3.2 transitivePeerDependencies: - eslint-import-resolver-webpack - supports-color dev: false - /eslint-config-prettier@8.8.0(eslint@8.54.0): + /eslint-config-prettier@8.8.0(eslint@8.55.0): resolution: {integrity: sha512-wLbQiFre3tdGgpDv67NQKnJuTlcUVYHas3k+DZCc2U2BadthoEY4B7hLPvAxaqdyOGCzuLfii2fqGph10va7oA==} hasBin: true peerDependencies: eslint: '>=7.0.0' dependencies: - eslint: 8.54.0 + eslint: 8.55.0 dev: false - /eslint-config-turbo@1.9.3(eslint@8.54.0): + /eslint-config-turbo@1.9.3(eslint@8.55.0): resolution: {integrity: sha512-QG6jxFQkrGSpQqlFKefPdtgUfr20EbU0s4tGGIuGFOcPuJEdsY6VYZpZUxNJvmMcTGqPgMyOPjAFBKhy/DPHLA==} peerDependencies: eslint: '>6.6.0' dependencies: - eslint: 8.54.0 - eslint-plugin-turbo: 1.9.3(eslint@8.54.0) + eslint: 8.55.0 + eslint-plugin-turbo: 1.9.3(eslint@8.55.0) dev: false /eslint-import-resolver-node@0.3.7: @@ -7631,7 +7701,7 @@ packages: - supports-color dev: false - /eslint-import-resolver-typescript@3.5.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-plugin-import@2.27.5)(eslint@8.54.0): + /eslint-import-resolver-typescript@3.5.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-plugin-import@2.27.5)(eslint@8.55.0): resolution: {integrity: sha512-TdJqPHs2lW5J9Zpe17DZNQuDnox4xo2o+0tE7Pggain9Rbc19ik8kFtXdxZ250FVx2kF4vlt2RSf4qlUpG7bhw==} engines: {node: ^14.18.0 || >=16.0.0} peerDependencies: @@ -7640,9 +7710,9 @@ packages: dependencies: debug: 4.3.4 enhanced-resolve: 5.13.0 - eslint: 8.54.0 - eslint-module-utils: 2.8.0(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-import-resolver-typescript@3.5.5)(eslint@8.54.0) - eslint-plugin-import: 2.27.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-typescript@3.5.5)(eslint@8.54.0) + eslint: 8.55.0 + eslint-module-utils: 2.8.0(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-import-resolver-typescript@3.5.5)(eslint@8.55.0) + eslint-plugin-import: 2.27.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-typescript@3.5.5)(eslint@8.55.0) get-tsconfig: 4.5.0 globby: 13.1.4 is-core-module: 2.12.0 @@ -7655,7 +7725,7 @@ packages: - supports-color dev: false - /eslint-module-utils@2.8.0(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-import-resolver-typescript@3.5.5)(eslint@8.54.0): + /eslint-module-utils@2.8.0(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-import-resolver-typescript@3.5.5)(eslint@8.55.0): resolution: {integrity: sha512-aWajIYfsqCKRDgUfjEXNN/JlrzauMuSEy5sbd7WXbtW3EH6A6MpwEh42c7qD+MqQo9QMJ6fWLAeIJynx0g6OAw==} engines: {node: '>=4'} peerDependencies: @@ -7676,16 +7746,16 @@ packages: eslint-import-resolver-webpack: optional: true dependencies: - '@typescript-eslint/parser': 5.59.2(eslint@8.54.0)(typescript@5.3.2) + '@typescript-eslint/parser': 5.59.2(eslint@8.55.0)(typescript@5.3.2) debug: 3.2.7 - eslint: 8.54.0 + eslint: 8.55.0 eslint-import-resolver-node: 0.3.7 - eslint-import-resolver-typescript: 3.5.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-plugin-import@2.27.5)(eslint@8.54.0) + eslint-import-resolver-typescript: 3.5.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-plugin-import@2.27.5)(eslint@8.55.0) transitivePeerDependencies: - supports-color dev: false - /eslint-plugin-import@2.27.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-typescript@3.5.5)(eslint@8.54.0): + /eslint-plugin-import@2.27.5(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-typescript@3.5.5)(eslint@8.55.0): resolution: {integrity: sha512-LmEt3GVofgiGuiE+ORpnvP+kAm3h6MLZJ4Q5HCyHADofsb4VzXFsRiWj3c0OFiV+3DWFh0qg3v9gcPlfc3zRow==} engines: {node: '>=4'} peerDependencies: @@ -7695,15 +7765,15 @@ packages: '@typescript-eslint/parser': optional: true dependencies: - '@typescript-eslint/parser': 5.59.2(eslint@8.54.0)(typescript@5.3.2) + '@typescript-eslint/parser': 5.59.2(eslint@8.55.0)(typescript@5.3.2) array-includes: 3.1.6 array.prototype.flat: 1.3.1 array.prototype.flatmap: 1.3.1 debug: 3.2.7 doctrine: 2.1.0 - eslint: 8.54.0 + eslint: 8.55.0 eslint-import-resolver-node: 0.3.7 - eslint-module-utils: 2.8.0(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-import-resolver-typescript@3.5.5)(eslint@8.54.0) + eslint-module-utils: 2.8.0(@typescript-eslint/parser@5.59.2)(eslint-import-resolver-node@0.3.7)(eslint-import-resolver-typescript@3.5.5)(eslint@8.55.0) has: 1.0.3 is-core-module: 2.12.0 is-glob: 4.0.3 @@ -7718,7 +7788,7 @@ packages: - supports-color dev: false - /eslint-plugin-jsx-a11y@6.7.1(eslint@8.54.0): + /eslint-plugin-jsx-a11y@6.7.1(eslint@8.55.0): resolution: {integrity: sha512-63Bog4iIethyo8smBklORknVjB0T2dwB8Mr/hIC+fBS0uyHdYYpzM/Ed+YC8VxTjlXHEWFOdmgwcDn1U2L9VCA==} engines: {node: '>=4.0'} peerDependencies: @@ -7733,7 +7803,7 @@ packages: axobject-query: 3.1.1 damerau-levenshtein: 1.0.8 emoji-regex: 9.2.2 - eslint: 8.54.0 + eslint: 8.55.0 has: 1.0.3 jsx-ast-utils: 3.3.3 language-tags: 1.0.5 @@ -7743,16 +7813,16 @@ packages: semver: 6.3.1 dev: false - /eslint-plugin-react-hooks@4.6.0(eslint@8.54.0): + /eslint-plugin-react-hooks@4.6.0(eslint@8.55.0): resolution: {integrity: sha512-oFc7Itz9Qxh2x4gNHStv3BqJq54ExXmfC+a1NjAta66IAN87Wu0R/QArgIS9qKzX3dXKPI9H5crl9QchNMY9+g==} engines: {node: '>=10'} peerDependencies: eslint: ^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0 dependencies: - eslint: 8.54.0 + eslint: 8.55.0 dev: false - /eslint-plugin-react@7.28.0(eslint@8.54.0): + /eslint-plugin-react@7.28.0(eslint@8.55.0): resolution: {integrity: sha512-IOlFIRHzWfEQQKcAD4iyYDndHwTQiCMcJVJjxempf203jnNLUnW34AXLrV33+nEXoifJE2ZEGmcjKPL8957eSw==} engines: {node: '>=4'} peerDependencies: @@ -7761,7 +7831,7 @@ packages: array-includes: 3.1.6 array.prototype.flatmap: 1.3.1 doctrine: 2.1.0 - eslint: 8.54.0 + eslint: 8.55.0 estraverse: 5.3.0 jsx-ast-utils: 3.3.3 minimatch: 3.1.2 @@ -7775,7 +7845,7 @@ packages: string.prototype.matchall: 4.0.8 dev: false - /eslint-plugin-react@7.32.2(eslint@8.54.0): + /eslint-plugin-react@7.32.2(eslint@8.55.0): resolution: {integrity: sha512-t2fBMa+XzonrrNkyVirzKlvn5RXzzPwRHtMvLAtVZrt8oxgnTQaYbU6SXTOO1mwQgp1y5+toMSKInnzGr0Knqg==} engines: {node: '>=4'} peerDependencies: @@ -7785,7 +7855,7 @@ packages: array.prototype.flatmap: 1.3.1 array.prototype.tosorted: 1.1.1 doctrine: 2.1.0 - eslint: 8.54.0 + eslint: 8.55.0 estraverse: 5.3.0 jsx-ast-utils: 3.3.3 minimatch: 3.1.2 @@ -7799,12 +7869,12 @@ packages: string.prototype.matchall: 4.0.8 dev: false - /eslint-plugin-turbo@1.9.3(eslint@8.54.0): + /eslint-plugin-turbo@1.9.3(eslint@8.55.0): resolution: {integrity: sha512-ZsRtksdzk3v+z5/I/K4E50E4lfZ7oYmLX395gkrUMBz4/spJlYbr+GC8hP9oVNLj9s5Pvnm9rLv/zoj5PVYaVw==} peerDependencies: eslint: '>6.6.0' dependencies: - eslint: 8.54.0 + eslint: 8.55.0 dev: false /eslint-scope@5.1.1: @@ -7871,6 +7941,53 @@ packages: transitivePeerDependencies: - supports-color + /eslint@8.55.0: + resolution: {integrity: sha512-iyUUAM0PCKj5QpwGfmCAG9XXbZCWsqP/eWAWrG/W0umvjuLRBECwSFdt+rCntju0xEH7teIABPwXpahftIaTdA==} + engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} + hasBin: true + dependencies: + '@eslint-community/eslint-utils': 4.4.0(eslint@8.55.0) + '@eslint-community/regexpp': 4.10.0 + '@eslint/eslintrc': 2.1.4 + '@eslint/js': 8.55.0 + '@humanwhocodes/config-array': 0.11.13 + '@humanwhocodes/module-importer': 1.0.1 + '@nodelib/fs.walk': 1.2.8 + '@ungap/structured-clone': 1.2.0 + ajv: 6.12.6 + chalk: 4.1.2 + cross-spawn: 7.0.3 + debug: 4.3.4 + doctrine: 3.0.0 + escape-string-regexp: 4.0.0 + eslint-scope: 7.2.2 + eslint-visitor-keys: 3.4.3 + espree: 9.6.1 + esquery: 1.5.0 + esutils: 2.0.3 + fast-deep-equal: 3.1.3 + file-entry-cache: 6.0.1 + find-up: 5.0.0 + glob-parent: 6.0.2 + globals: 13.23.0 + graphemer: 1.4.0 + ignore: 5.3.0 + imurmurhash: 0.1.4 + is-glob: 4.0.3 + is-path-inside: 3.0.3 + js-yaml: 4.1.0 + json-stable-stringify-without-jsonify: 1.0.1 + levn: 0.4.1 + lodash.merge: 4.6.2 + minimatch: 3.1.2 + natural-compare: 1.4.0 + optionator: 0.9.3 + strip-ansi: 6.0.1 + text-table: 0.2.0 + transitivePeerDependencies: + - supports-color + dev: false + /espree@9.6.1: resolution: {integrity: sha512-oruZaFkjorTpF32kDSI5/75ViwGeZginGGy2NoOSg3Q9bnwlnmDm4HLnkl0RE3n+njDXR037aY1+x58Z/zFdwQ==} engines: {node: ^12.22.0 || ^14.17.0 || >=16.0.0} @@ -7922,7 +8039,7 @@ packages: resolution: {integrity: sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==} engines: {node: '>= 0.8'} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 require-like: 0.1.2 dev: false @@ -8679,7 +8796,7 @@ packages: array-union: 2.1.0 dir-glob: 3.0.1 fast-glob: 3.3.2 - ignore: 5.2.4 + ignore: 5.3.0 merge2: 1.4.1 slash: 3.0.0 @@ -9201,6 +9318,10 @@ packages: resolution: {integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==} engines: {node: '>= 4'} + /ignore@5.3.0: + resolution: {integrity: sha512-g7dmpshy+gD7mh88OC9NwSGTKoc3kyLAZQRU1mt53Aw/vnvfXnbC+F/7F7QoYVKbV+KNvJx8wArewKy1vXMtlg==} + engines: {node: '>= 4'} + /image-size@1.0.2: resolution: {integrity: sha512-xfOoWjceHntRb3qFCrh5ZFORYH8XCdYpASltMhZ/Q0KZiOwjdE/Yl2QCiWdwD+lygV5bMCvauzgu5PxBX/Yerg==} engines: {node: '>=14.0.0'} @@ -9835,7 +9956,7 @@ packages: '@jest/expect': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 chalk: 4.1.2 co: 4.6.0 dedent: 1.5.1 @@ -9856,7 +9977,7 @@ packages: - supports-color dev: true - /jest-cli@29.7.0(@types/node@18.18.12): + /jest-cli@29.7.0(@types/node@20.10.3): resolution: {integrity: sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -9870,10 +9991,10 @@ packages: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 chalk: 4.1.2 - create-jest: 29.7.0(@types/node@18.18.12) + create-jest: 29.7.0(@types/node@20.10.3) exit: 0.1.2 import-local: 3.1.0 - jest-config: 29.7.0(@types/node@18.18.12) + jest-config: 29.7.0(@types/node@20.10.3) jest-util: 29.7.0 jest-validate: 29.7.0 yargs: 17.7.2 @@ -9884,7 +10005,7 @@ packages: - ts-node dev: true - /jest-config@29.7.0(@types/node@18.18.12): + /jest-config@29.7.0(@types/node@20.10.3): resolution: {integrity: sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: @@ -9899,7 +10020,7 @@ packages: '@babel/core': 7.23.3 '@jest/test-sequencer': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 babel-jest: 29.7.0(@babel/core@7.23.3) chalk: 4.1.2 ci-info: 3.9.0 @@ -9959,7 +10080,7 @@ packages: '@jest/environment': 29.7.0 '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 jest-mock: 29.7.0 jest-util: 29.7.0 dev: true @@ -9975,7 +10096,7 @@ packages: dependencies: '@jest/types': 29.6.3 '@types/graceful-fs': 4.1.9 - '@types/node': 18.18.12 + '@types/node': 20.10.3 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.11 @@ -10026,7 +10147,7 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 jest-util: 29.7.0 dev: true @@ -10081,7 +10202,7 @@ packages: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 chalk: 4.1.2 emittery: 0.13.1 graceful-fs: 4.2.11 @@ -10112,7 +10233,7 @@ packages: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 chalk: 4.1.2 cjs-module-lexer: 1.2.3 collect-v8-coverage: 1.0.2 @@ -10164,7 +10285,7 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 chalk: 4.1.2 ci-info: 3.9.0 graceful-fs: 4.2.11 @@ -10188,7 +10309,7 @@ packages: dependencies: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.18.12 + '@types/node': 20.10.3 ansi-escapes: 4.3.2 chalk: 4.1.2 emittery: 0.13.1 @@ -10200,7 +10321,7 @@ packages: resolution: {integrity: sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==} engines: {node: '>= 10.13.0'} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 merge-stream: 2.0.0 supports-color: 8.1.1 @@ -10208,12 +10329,12 @@ packages: resolution: {integrity: sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@types/node': 18.18.12 + '@types/node': 20.10.3 jest-util: 29.7.0 merge-stream: 2.0.0 supports-color: 8.1.1 - /jest@29.7.0(@types/node@18.18.12): + /jest@29.7.0(@types/node@20.10.3): resolution: {integrity: sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -10226,7 +10347,7 @@ packages: '@jest/core': 29.7.0 '@jest/types': 29.6.3 import-local: 3.1.0 - jest-cli: 29.7.0(@types/node@18.18.12) + jest-cli: 29.7.0(@types/node@20.10.3) transitivePeerDependencies: - '@types/node' - babel-plugin-macros @@ -10433,6 +10554,11 @@ packages: resolution: {integrity: sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ==} engines: {node: '>=10'} + /lilconfig@3.0.0: + resolution: {integrity: sha512-K2U4W2Ff5ibV7j7ydLr+zLAkIg5JJ4lPn1Ltsdt+Tz/IjQ8buJ55pZAxoP34lqIiwtF9iAvtLv3JGv7CAyAg+g==} + engines: {node: '>=14'} + dev: true + /lines-and-columns@1.2.4: resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} @@ -11173,8 +11299,8 @@ packages: tslib: 2.6.2 dev: false - /node-abi@3.51.0: - resolution: {integrity: sha512-SQkEP4hmNWjlniS5zdnfIXTk1x7Ome85RDzHlTbBtzE97Gfwz/Ipw4v/Ryk20DWIy3yCNVLVlGKApCnmvYoJbA==} + /node-abi@3.52.0: + resolution: {integrity: sha512-JJ98b02z16ILv7859irtXn4oUaFWADtvkzy2c0IAatNVX2Mc9Yoh8z6hZInn3QwvMEYhHuQloYi+TTQy67SIdQ==} engines: {node: '>=10'} dependencies: semver: 7.5.4 @@ -11241,6 +11367,10 @@ packages: /node-releases@2.0.13: resolution: {integrity: sha512-uYr7J37ae/ORWdZeQ1xxMJe3NtdmqMC/JZK+geofDrkLUApKRHPd18/TxtBOJ4A0/+uUIliorNrfYV6s1b02eQ==} + /node-releases@2.0.14: + resolution: {integrity: sha512-y10wOWt8yZpqXmOgRo77WaHEmhYQYGNA6y421PKsKYWEK8aW+cqAphborZDhqfyKrbZEN92CN1X2KbafY2s7Yw==} + dev: false + /node-stdlib-browser@1.2.0: resolution: {integrity: sha512-VSjFxUhRhkyed8AtLwSCkMrJRfQ3e2lGtG3sP6FEgaLKBBbxM/dLfjRe1+iLhjvyLFW3tBQ8+c0pcOtXGbAZJg==} engines: {node: '>=10'} @@ -11304,7 +11434,7 @@ packages: /notion-md-crawler@0.0.2: resolution: {integrity: sha512-lE3/DFMrg7GSbl1sBfDuLVLyxw+yjdarPVm1JGfQ6eONEbNGgO+BdZxpwwZQ1uYeEJurAXMXb/AXT8GKYjKAyg==} dependencies: - '@notionhq/client': 2.2.13 + '@notionhq/client': 2.2.14 md-utils-ts: 2.0.0 transitivePeerDependencies: - encoding @@ -11368,6 +11498,16 @@ packages: has-symbols: 1.0.3 object-keys: 1.1.1 + /object.assign@4.1.5: + resolution: {integrity: sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==} + engines: {node: '>= 0.4'} + dependencies: + call-bind: 1.0.5 + define-properties: 1.2.1 + has-symbols: 1.0.3 + object-keys: 1.1.1 + dev: true + /object.entries@1.1.6: resolution: {integrity: sha512-leTPzo4Zvg3pmbQ3rDK69Rl8GQvIqMWubrkxONG9/ojtFE2rD9fjMKfSI5BxW3osRH1m6VdzmqK8oAY9aT4x5w==} engines: {node: '>= 0.4'} @@ -11489,11 +11629,11 @@ packages: is-wsl: 2.2.0 dev: false - /openai@4.20.0: - resolution: {integrity: sha512-VbAYerNZFfIIeESS+OL9vgDkK8Mnri55n+jN0UN/HZeuM0ghGh6nDN6UGRZxslNgyJ7XmY/Ca9DO4YYyvrszGA==} + /openai@4.20.1: + resolution: {integrity: sha512-Dd3q8EvINfganZFtg6V36HjrMaihqRgIcKiHua4Nq9aw/PxOP48dhbsk8x5klrxajt5Lpnc1KTOG5i1S6BKAJA==} hasBin: true dependencies: - '@types/node': 18.18.12 + '@types/node': 18.19.2 '@types/node-fetch': 2.6.9 abort-controller: 3.0.0 agentkeepalive: 4.5.0 @@ -12093,8 +12233,8 @@ packages: postcss-selector-parser: 6.0.13 dev: false - /postcss-load-config@4.0.1: - resolution: {integrity: sha512-vEJIc8RdiBRu3oRAI0ymerOn+7rPuMvRXslTvZUKZonDHFIczxztIyJ1urxM1x9JXEikvpWWTUUqal5j/8QgvA==} + /postcss-load-config@4.0.2: + resolution: {integrity: sha512-bSVhyJGL00wMVoPUzAVAnbEoWyqRxkjv64tUl427SKnPrENtq6hJwUojroMz2VB+Q1edmi4IfrAPpami5VVgMQ==} engines: {node: '>= 14'} peerDependencies: postcss: '>=8.0.9' @@ -12105,7 +12245,7 @@ packages: ts-node: optional: true dependencies: - lilconfig: 2.1.0 + lilconfig: 3.0.0 yaml: 2.3.4 dev: true @@ -12507,7 +12647,7 @@ packages: minimist: 1.2.8 mkdirp-classic: 0.5.3 napi-build-utils: 1.0.2 - node-abi: 3.51.0 + node-abi: 3.52.0 pump: 3.0.0 rc: 1.2.8 simple-get: 4.0.1 @@ -12656,7 +12796,7 @@ packages: '@protobufjs/pool': 1.1.0 '@protobufjs/utf8': 1.1.0 '@types/long': 4.0.2 - '@types/node': 18.18.12 + '@types/node': 18.19.2 long: 4.0.0 dev: false @@ -13574,8 +13714,8 @@ packages: ajv-keywords: 5.1.0(ajv@8.12.0) dev: false - /search-insights@2.10.0: - resolution: {integrity: sha512-pQGrOE56QuTRmq4NzliRZe9rv914hBMBjOviuDliDHoIhmBGoyZRlFsPd4RprGGNC4PKdD2Jz54YN4Cmkb44mA==} + /search-insights@2.11.0: + resolution: {integrity: sha512-Uin2J8Bpm3xaZi9Y8QibSys6uJOFZ+REMrf42v20AA3FUDUrshKkMEP6liJbMAHCm71wO6ls4mwAf7a3gFVxLw==} dev: false /section-matter@1.0.0: @@ -14147,7 +14287,7 @@ packages: resolution: {integrity: sha512-9ketPUGy6MWmHy5tZuy1LSXcEB690MCQ0eTvUlunCjCGGTIUjboHyFa/PADndYHlfvHDcdO9iwzqjheXI/K/jw==} engines: {node: '>=14.18.0'} dependencies: - '@types/lodash-es': 4.17.10 + '@types/lodash-es': 4.17.12 codsen-utils: 1.6.2 html-entities: 2.4.0 lodash-es: 4.17.21 @@ -14735,7 +14875,7 @@ packages: '@babel/core': 7.23.3 bs-logger: 0.2.6 fast-json-stable-stringify: 2.1.0 - jest: 29.7.0(@types/node@18.18.12) + jest: 29.7.0(@types/node@20.10.3) jest-util: 29.7.0 json5: 2.2.3 lodash.memoize: 4.1.2 @@ -14776,6 +14916,37 @@ packages: yn: 3.1.1 dev: true + /ts-node@10.9.1(@types/node@20.10.3)(typescript@5.3.2): + resolution: {integrity: sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==} + hasBin: true + peerDependencies: + '@swc/core': '>=1.2.50' + '@swc/wasm': '>=1.2.50' + '@types/node': '*' + typescript: '>=2.7' + peerDependenciesMeta: + '@swc/core': + optional: true + '@swc/wasm': + optional: true + dependencies: + '@cspotcode/source-map-support': 0.8.1 + '@tsconfig/node10': 1.0.9 + '@tsconfig/node12': 1.0.11 + '@tsconfig/node14': 1.0.3 + '@tsconfig/node16': 1.0.4 + '@types/node': 20.10.3 + acorn: 8.11.2 + acorn-walk: 8.3.0 + arg: 4.1.3 + create-require: 1.1.1 + diff: 4.0.2 + make-error: 1.3.6 + typescript: 5.3.2 + v8-compile-cache-lib: 3.0.1 + yn: 3.1.1 + dev: true + /tsconfig-paths@3.14.2: resolution: {integrity: sha512-o/9iXgCYc5L/JxCHPe3Hvh8Q/2xm5Z+p18PESBU6Ff33695QnCHBEjcytY2q19ua7Mbl/DavtBOLq+oG0RCL+g==} dependencies: @@ -14819,7 +14990,7 @@ packages: execa: 5.1.1 globby: 11.1.0 joycon: 3.1.1 - postcss-load-config: 4.0.1 + postcss-load-config: 4.0.2 resolve-from: 5.0.0 rollup: 3.29.4 source-map: 0.8.0-beta.0 @@ -15235,6 +15406,17 @@ packages: escalade: 3.1.1 picocolors: 1.0.0 + /update-browserslist-db@1.0.13(browserslist@4.22.2): + resolution: {integrity: sha512-xebP81SNcPuNpPP3uzeW1NYXxI3rxyJzF3pD6sH4jE7o/IX+WtSpwnVU+qIsDPyk0d3hmFQ7mjqc6AtV604hbg==} + hasBin: true + peerDependencies: + browserslist: '>= 4.21.0' + dependencies: + browserslist: 4.22.2 + escalade: 3.1.1 + picocolors: 1.0.0 + dev: false + /update-check@1.5.4: resolution: {integrity: sha512-5YHsflzHP4t1G+8WGPlvKbJEbAJGCgw+Em+dGR1KmBUbr1J36SJBqlHLjR7oob7sco5hWHGQVcr9B2poIVDDTQ==} dependencies: @@ -15684,7 +15866,7 @@ packages: '@webassemblyjs/wasm-parser': 1.11.6 acorn: 8.11.2 acorn-import-assertions: 1.9.0(acorn@8.11.2) - browserslist: 4.22.1 + browserslist: 4.22.2 chrome-trace-event: 1.0.3 enhanced-resolve: 5.15.0 es-module-lexer: 1.4.1