mirror of
https://github.com/infiniflow/ragflow.git
synced 2025-12-08 12:32:30 +08:00
Fix bugs in api and add examples (#3353)
### What problem does this PR solve? Fix bugs in api. Add simple examples for api. ### Type of change - [x] Bug Fix (non-breaking change which fixes an issue) - [x] New Feature (non-breaking change which adds functionality) --------- Co-authored-by: liuhua <10215101452@stu.ecun.edu.cn> Co-authored-by: Kevin Hu <kevinhu.sh@gmail.com>
This commit is contained in:
52
example/http/simple_example.sh
Normal file
52
example/http/simple_example.sh
Normal file
@ -0,0 +1,52 @@
|
||||
#
|
||||
# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
# Create a dataset
|
||||
echo -e "\n-- Create a dataset"
|
||||
curl --request POST \
|
||||
--url http://localhost:9380/api/v1/datasets \
|
||||
--header 'Content-Type: application/json' \
|
||||
--header 'Authorization: Bearer ragflow-IzZmY1MGVhYTBhMjExZWZiYTdjMDI0Mm' \
|
||||
--data '{
|
||||
"name": "test"
|
||||
}'
|
||||
|
||||
# Update the dataset
|
||||
echo -e "\n-- Update the dataset"
|
||||
curl --request PUT \
|
||||
--url http://localhost:9380/api/v1/datasets/2e898768a0bc11efb46a0242ac120006 \
|
||||
--header 'Content-Type: application/json' \
|
||||
--header 'Authorization: Bearer ragflow-IzZmY1MGVhYTBhMjExZWZiYTdjMDI0Mm' \
|
||||
--data '
|
||||
{
|
||||
"name": "updated_dataset"
|
||||
}'
|
||||
|
||||
# List datasets
|
||||
echo -e "\n-- List datasets"
|
||||
curl --request GET \
|
||||
--url http://127.0.0.1:9380/api/v1/datasets \
|
||||
--header 'Authorization: Bearer ragflow-IzZmY1MGVhYTBhMjExZWZiYTdjMDI0Mm'
|
||||
|
||||
# Delete datasets
|
||||
echo -e "\n-- Delete datasets"
|
||||
curl --request DELETE \
|
||||
--url http://localhost:9380/api/v1/datasets \
|
||||
--header 'Content-Type: application/json' \
|
||||
--header 'Authorization: Bearer ragflow-IzZmY1MGVhYTBhMjExZWZiYTdjMDI0Mm' \
|
||||
--data '{
|
||||
"ids": ["301298b8a0bc11efa0440242ac120006"]
|
||||
}'
|
||||
55
example/sdk/simple_example.py
Normal file
55
example/sdk/simple_example.py
Normal file
@ -0,0 +1,55 @@
|
||||
#
|
||||
# Copyright 2024 The InfiniFlow Authors. All Rights Reserved.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
#
|
||||
|
||||
'''
|
||||
The example is about CRUD operations (Create, Read, Update, Delete) on a dataset.
|
||||
'''
|
||||
|
||||
from ragflow_sdk import RAGFlow
|
||||
import sys
|
||||
|
||||
HOST_ADDRESS = "http://127.0.0.1"
|
||||
API_KEY = "ragflow-IzZmY1MGVhYTBhMjExZWZiYTdjMDI0Mm"
|
||||
|
||||
try:
|
||||
# create a ragflow instance
|
||||
ragflow_instance = RAGFlow(api_key=API_KEY, base_url=HOST_ADDRESS)
|
||||
|
||||
# crate a dataset instance
|
||||
dataset_instance = ragflow_instance.create_dataset(name="dataset_instance")
|
||||
|
||||
# update the dataset instance
|
||||
updated_message = {"name":"updated_dataset"}
|
||||
updated_dataset = dataset_instance.update(updated_message)
|
||||
|
||||
# get the dataset (list datasets)
|
||||
dataset_list = ragflow_instance.list_datasets(id=dataset_instance.id)
|
||||
dataset_instance_2 = dataset_list[0]
|
||||
print(dataset_instance)
|
||||
print(dataset_instance_2)
|
||||
|
||||
# delete the dataset (delete datasets)
|
||||
to_be_deleted_datasets = [dataset_instance.id]
|
||||
ragflow_instance.delete_datasets(ids=to_be_deleted_datasets)
|
||||
|
||||
print("test done")
|
||||
sys.exit(0)
|
||||
|
||||
except Exception as e:
|
||||
print(str(e))
|
||||
sys.exit(-1)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user