### What problem does this PR solve? 1. Fixed swagger docs error in nginx external port 2. Add retrieval api 3. Add documentation for SDK API ### Type of change - [x] Bug Fix (non-breaking change which fixes an issue) - [x] Documentation Update - [x] Refactoring
113 lines
3.9 KiB
Python
113 lines
3.9 KiB
Python
#
|
|
# 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.
|
|
#
|
|
|
|
from api.apps import http_token_auth
|
|
from api.apps.services import dataset_service
|
|
from api.settings import RetCode
|
|
from api.utils.api_utils import server_error_response, http_basic_auth_required, get_json_result
|
|
|
|
|
|
@manager.post('')
|
|
@manager.input(dataset_service.CreateDatasetReq, location='json')
|
|
@manager.auth_required(http_token_auth)
|
|
def create_dataset(json_data):
|
|
"""Creates a new Dataset(Knowledgebase)."""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.create_dataset(tenant_id, json_data)
|
|
except Exception as e:
|
|
return server_error_response(e)
|
|
|
|
|
|
@manager.put('')
|
|
@manager.input(dataset_service.UpdateDatasetReq, location='json')
|
|
@manager.auth_required(http_token_auth)
|
|
def update_dataset(json_data):
|
|
"""Updates a Dataset(Knowledgebase)."""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.update_dataset(tenant_id, json_data)
|
|
except Exception as e:
|
|
return server_error_response(e)
|
|
|
|
|
|
@manager.get('/<string:kb_id>')
|
|
@manager.auth_required(http_token_auth)
|
|
def get_dataset_by_id(kb_id):
|
|
"""Query Dataset(Knowledgebase) by Dataset(Knowledgebase) ID."""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.get_dataset_by_id(tenant_id, kb_id)
|
|
except Exception as e:
|
|
return server_error_response(e)
|
|
|
|
|
|
@manager.get('/search')
|
|
@manager.input(dataset_service.SearchDatasetReq, location='query')
|
|
@manager.auth_required(http_token_auth)
|
|
def get_dataset_by_name(query_data):
|
|
"""Query Dataset(Knowledgebase) by Name."""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.get_dataset_by_name(tenant_id, query_data["name"])
|
|
except Exception as e:
|
|
return server_error_response(e)
|
|
|
|
|
|
@manager.get('')
|
|
@manager.input(dataset_service.QueryDatasetReq, location='query')
|
|
@http_basic_auth_required
|
|
@manager.auth_required(http_token_auth)
|
|
def get_all_datasets(query_data):
|
|
"""Query all Datasets(Knowledgebase)"""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.get_all_datasets(
|
|
tenant_id,
|
|
query_data['page'],
|
|
query_data['page_size'],
|
|
query_data['orderby'],
|
|
query_data['desc'],
|
|
)
|
|
except Exception as e:
|
|
return server_error_response(e)
|
|
|
|
|
|
@manager.delete('/<string:kb_id>')
|
|
@manager.auth_required(http_token_auth)
|
|
def delete_dataset(kb_id):
|
|
"""Deletes a Dataset(Knowledgebase)."""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.delete_dataset(tenant_id, kb_id)
|
|
except Exception as e:
|
|
return server_error_response(e)
|
|
|
|
|
|
@manager.post('/retrieval')
|
|
@manager.input(dataset_service.RetrievalReq, location='json')
|
|
@manager.auth_required(http_token_auth)
|
|
def retrieval_in_dataset(json_data):
|
|
"""Run document retrieval in one or more Datasets(Knowledgebase)."""
|
|
try:
|
|
tenant_id = http_token_auth.current_user.id
|
|
return dataset_service.retrieval_in_dataset(tenant_id, json_data)
|
|
except Exception as e:
|
|
if str(e).find("not_found") > 0:
|
|
return get_json_result(data=False, retmsg=f'No chunk found! Check the chunk status please!',
|
|
retcode=RetCode.DATA_ERROR)
|
|
return server_error_response(e)
|