Knowledge Base Python 데모 시작

일반적인 Knowledge Base API 워크플로의 작동 중인 Python 구현을 실행, 검사 및 수정합니다.

Python 데모는 애플리케이션 개발을 위한 기능적인 시작점을 제공합니다. 완전한 워크플로를 사용하여 컬렉션 생성, 문서 처리, AI 추론이 함께 작동하는 것을 확인한 다음, 특정 컬렉션 및 추론 작업을 위한 개별 스크립트를 탐색해 보세요.

시작하기 전에

다음을 확인하세요.

• Knowledge Base API에 액세스합니다.
• 애플리케이션을 인증하는 데 필요한 자격 증명
• Python 3.7 이상 Python 3.11 이상을 권장합니다.
• 완전한 데모 워크플로에 사용할 수 있는 PDF

API 액세스를 구성하지 않은 경우 Knowledge Base API 액세스 설정을 참조하세요.

Python 데모 다운로드 및 설정

데모는 requests, pyyaml, tqdm을 사용합니다. 자격 증명은 config.yaml에 저장되며, 인증 토큰은 자동으로 관리됩니다.

config.yaml 또는 생성된 .token 파일을 소스 컨트롤에 커밋하지 마세요.

전체 워크플로 실행

실행:

python knowledgebase.py

특정 PDF를 사용하려면:

python knowledgebase.py --document=<path-to-pdf>

데모:

1. API로 인증합니다.
2. demo-collection이라는 컬렉션을 만듭니다.
3. PDF를 업로드합니다.
4. 색인화가 완료될 때까지 문서를 모니터링합니다.
5. 처리된 문서에 대해 추론 요청을 실행합니다.

업로드와 색인화는 문서 수집의 별개 부분입니다. 색인화는 문서 콘텐츠를 추출하고 AI 작업에서 사용할 수 있도록 만들어 줍니다.

PDF를 지정하지 않으면 데모는 패키지의 documents 디렉터리에서 하나를 선택합니다. 문서 처리가 완료 상태에 도달하지 않으면 5분 후에 시간이 초과됩니다.

컬렉션 작업 살펴보기

전체 워크플로를 실행한 후 개별 스크립트를 사용하여 특정 API 작업을 살펴보세요.

컬렉션 만들기

python collection.py --action create --name <collection-name>

컬렉션 이름은 최대 255자까지 포함할 수 있습니다.

컬렉션 목록 보기

python collection.py --action list

메시지가 표시되면 본인이 만든 컬렉션, 본인이 공유한 컬렉션, 다른 사용자가 공유한 컬렉션 중 나열할 컬렉션을 선택합니다.

컬렉션 공유

python collection.py --action share --collection-id <collection-id>

메시지가 표시되면 읽기 또는 쓰기 액세스 권한을 받을 이메일 주소를 입력합니다.

문서 업로드

python collection.py --action upload --collection-id <collection-id> --path=<path-to-file-or-directory>

스크립트는 단일 파일 또는 지정된 디렉터리의 문서를 업로드할 수 있습니다.

컬렉션의 문서 목록 표시

python collection.py --action get_documents --collection-id <collection-id>

문서 처리 상태 확인

python collection.py --action get_status --document-id <document-id>

데모는 전체 워크플로와 독립적으로 검토하고 조정할 수 있는 독립형 예제로 이러한 작업을 제공합니다. 

추론 작업 살펴보기

추론 예제에는 컬렉션 ID와 문서 ID가 필요합니다. 컬렉션 스크립트를 사용하여 식별하세요:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>

질의응답

컬렉션과 문서를 나열한 다음 Q&A 예제를 실행하세요.

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer

프롬프트가 나타나면 컬렉션 ID, 문서 ID, 질문을 입력하세요.

문서 요약

컬렉션과 문서를 식별한 다음 요약 예제를 실행하세요:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize

프롬프트가 나타나면 컬렉션 ID와 문서 ID를 입력하세요.

컨텍스트 검색

컬렉션과 문서를 식별한 다음 컨텍스트 검색 예제를 실행하세요.

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search

프롬프트가 나타나면 컬렉션 ID, 문서 ID, 검색 텍스트를 입력하세요.

속성 추출

컬렉션과 문서를 식별한 다음 추출 예제를 실행하세요:

python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract

메시지가 표시되면 컬렉션 ID, 문서 ID, 속성 이름, 추출 프롬프트, 데이터 유형 및 선택적 설명을 입력하세요. 

API로 계속 빌드하기

Python 데모는 완전한 API 문서가 아닌 실용적인 구현 패턴을 제공합니다.

기술 자료 API 시작하기를 사용하여 API 리소스 모델, 문서 수명 주기, 추론 동작 및 응답 처리를 이해하세요.

현재 엔드포인트 경로, 매개변수, 요청 및 응답 스키마, 상태 정보가 필요할 때는 기술 자료 API 참조를 사용하세요.

문제 해결

데모는 자세한 진단 정보를 다음에 기록합니다:

logs/knowledgebase-demo.log

로그 파일에는 DEBUG 레벨 정보가 기록되고, 콘솔에는 WARNING 레벨 메시지 이상이 표시됩니다.

작업이 실패하는 경우:

• logs/kinowledgebase-demo.log에서 요청 및 인증 세부 정보를 검토하세요.
• config.yaml의 설정을 확인하세요.
• 사용 중인 PDF가 존재하고 액세스 가능한지 확인하세요.
• 애플리케이션이 조직에 적합한 서비스 엔드포인트를 사용하고 있는지 확인하세요. 
• 인증된 ID가 요청된 리소스에 액세스할 수 있는지 확인하세요.
• API 실패 시, 사용 가능한 경우 응답 헤더에서 반환된 X-Request-ID를 보관하세요. 지원팀에서 이 식별자를 사용하여 요청을 추적할 수 있습니다. 

구현 고려 사항

• 전체 워크플로에서 PDF 파일을 허용합니다.
• 데모는 API 액세스 구성 후 인증 토큰을 관리합니다.
• API 작업은 인증된 ID에 부여된 권한을 사용합니다.
• 소스 패키지에는 지역 엔드포인트 검색 기능이 포함되어 있지만, 프로덕션 엔드포인트 값은 데모에 포함된 이전 값이 아닌 현재 기술 자료 API 문서에서 가져와야 합니다.