| Name | llama-index-readers-dashscope-custom JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | llama-index readers dashscope integration |
| upload_time | 2024-05-08 05:44:57 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <4.0,>=3.8.1 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# LlamaIndex Readers Integration: Dashscope
## Usage
```python
from llama_index.readers.dashscope.base import DashScopeParse
from llama_index.readers.dashscope.utils import ResultType
file_list = [
# your files (accept doc, docx, pdf)
]
parse = DashScopeParse(result_type=ResultType.DASHCOPE_DOCMIND)
documents = parse.load_data(file_path=file_list)
```
## Reader Setting:
A full list of retriever settings/kwargs is below:
- api_key: Optional[str] -- Your dashscope API key, which can be passed in through environment variables or parameters.
The parameter settings will override the results from the environment variables
- workspace_id: Optional[str] -- Your dashscope workspace_id, which can be passed in through environment variables or
parameters. The parameter settings will override the results from the environment variables
- base_url: Optional[str] -- The base url for the Dashscope API. The default value is "https://dashscope.aliyuncs.com".
The parameter settings will override the results from the environment variables.
- result_type: Optional[ResultType] -- The result type for the parser. The default value is ResultType.DASHCOPE_DOCMIND.
- num_workers: Optional[int] -- The number of workers to use sending API requests for parsing. The default value is 4,
greater than 0, less than 10.
- check_interval: Optional[int] -- The interval in seconds to check if the parsing is done. The default value is 2.
- max_timeout: Optional[int] -- The maximum timeout in seconds to wait for the parsing to finish. The default value is 20000.
- verbose: Optional[bool] -- Whether to print the progress of the parsing. The default value is True.
- show_progress: Optional[bool] -- Show progress when parsing multiple files. The default value is True.
- ignore_errors: Optional[bool] -- Whether or not to ignore and skip errors raised during parsing. The default value is
True.
## Reader Input:
- file_path: Union[str, List[str]] -- The file path or list of file paths to parse.
## Reader Output:
- List[llama_index.core.schema.Document] -- The list of documents parsed from the file.
- text: str -- The text of the document from DASHCOPE_DOCMIND.
Raw data
{
"_id": null,
"home_page": null,
"name": "llama-index-readers-dashscope-custom",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8.1",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/3c/14/3fcf289165f21a70905db547d2f738cf7c7624cf21481dfa3e371d9d2281/llama_index_readers_dashscope_custom-0.1.0.tar.gz",
"platform": null,
"description": "# LlamaIndex Readers Integration: Dashscope\n\n## Usage\n\n```python\nfrom llama_index.readers.dashscope.base import DashScopeParse\nfrom llama_index.readers.dashscope.utils import ResultType\n\nfile_list = [\n # your files (accept doc, docx, pdf)\n]\n\nparse = DashScopeParse(result_type=ResultType.DASHCOPE_DOCMIND)\ndocuments = parse.load_data(file_path=file_list)\n```\n\n## Reader Setting:\n\nA full list of retriever settings/kwargs is below:\n\n- api_key: Optional[str] -- Your dashscope API key, which can be passed in through environment variables or parameters.\n The parameter settings will override the results from the environment variables\n- workspace_id: Optional[str] -- Your dashscope workspace_id, which can be passed in through environment variables or\n parameters. The parameter settings will override the results from the environment variables\n- base_url: Optional[str] -- The base url for the Dashscope API. The default value is \"https://dashscope.aliyuncs.com\".\n The parameter settings will override the results from the environment variables.\n- result_type: Optional[ResultType] -- The result type for the parser. The default value is ResultType.DASHCOPE_DOCMIND.\n- num_workers: Optional[int] -- The number of workers to use sending API requests for parsing. The default value is 4,\n greater than 0, less than 10.\n- check_interval: Optional[int] -- The interval in seconds to check if the parsing is done. The default value is 2.\n- max_timeout: Optional[int] -- The maximum timeout in seconds to wait for the parsing to finish. The default value is 20000.\n- verbose: Optional[bool] -- Whether to print the progress of the parsing. The default value is True.\n- show_progress: Optional[bool] -- Show progress when parsing multiple files. The default value is True.\n- ignore_errors: Optional[bool] -- Whether or not to ignore and skip errors raised during parsing. The default value is\n True.\n\n## Reader Input:\n\n- file_path: Union[str, List[str]] -- The file path or list of file paths to parse.\n\n## Reader Output:\n\n- List[llama_index.core.schema.Document] -- The list of documents parsed from the file.\n - text: str -- The text of the document from DASHCOPE_DOCMIND.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "llama-index readers dashscope integration",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6e215ef37a51d025283d8fbfd0f95976d1d962db7c236a4e4dad91808177797",
"md5": "d05e7240363841547d78e67a41c2db1b",
"sha256": "66718457e1b1ecde5d8a9d536b1dca2664540180c37e4ded8a7fc4b2a447028b"
},
"downloads": -1,
"filename": "llama_index_readers_dashscope_custom-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d05e7240363841547d78e67a41c2db1b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8.1",
"size": 10385,
"upload_time": "2024-05-08T05:44:55",
"upload_time_iso_8601": "2024-05-08T05:44:55.743658Z",
"url": "https://files.pythonhosted.org/packages/d6/e2/15ef37a51d025283d8fbfd0f95976d1d962db7c236a4e4dad91808177797/llama_index_readers_dashscope_custom-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c143fcf289165f21a70905db547d2f738cf7c7624cf21481dfa3e371d9d2281",
"md5": "3ab1732e135b6603ccb07ece062c95b8",
"sha256": "268d2c47ff167a3089398fd3c3eeff6d185059e1e7008acd32ba71b3811b06f5"
},
"downloads": -1,
"filename": "llama_index_readers_dashscope_custom-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3ab1732e135b6603ccb07ece062c95b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8.1",
"size": 9528,
"upload_time": "2024-05-08T05:44:57",
"upload_time_iso_8601": "2024-05-08T05:44:57.134516Z",
"url": "https://files.pythonhosted.org/packages/3c/14/3fcf289165f21a70905db547d2f738cf7c7624cf21481dfa3e371d9d2281/llama_index_readers_dashscope_custom-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 05:44:57",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "llama-index-readers-dashscope-custom"
}
