Fess API 가이드

시작하기

시작하기

• 대상 독자
• 읽기 전에
• API 사용 전제 조건
• 온라인 액세스
• 기술 지원 연락처
• 관련 제3자 웹사이트 참조
• 의견 및 제안 제출 방법

API 빠른 시작

• 5분으로 시작하기
• Postman 에서 사용하기
• 프로그래밍 언어별 샘플
• API 버전 대응표
• 트러블슈팅
• 다음 단계

공통 사양

API 개요

• Fess 에서 제공하는 API
• 베이스 URL
• 응답 엔벨로프
• 오류 응답
• 인증과 세션
• 스트리밍 형식
• API 종류

검색 API

검색 API

• 문서 검색
• 전체 문서 취득 (스크롤 검색·NDJSON)

레이블 API

• 레이블 취득
• 사용 예
• 오류 응답

인기 검색어 API

• 인기 검색어 목록 취득
• 사용 예
• 오류 응답

자동완성 API

• 자동완성 단어 목록 취득
• 사용 예
• 오류 응답

관련 쿼리·관련 콘텐츠 API

• 관련 쿼리 취득
• 관련 콘텐츠 취득

Health API

• 상태 취득
• 사용 예
• 응답 및 오류 응답

인증·UI

인증·세션 API

• 개요
• 공통 사용자 정보 (UserPayload)
• 인증 상태 취득
• 로그인
• 로그아웃
• 비밀번호 변경

UI 설정 API

• 개요
• UI 설정 취득

사용자 기능 API

즐겨찾기 API

• 즐겨찾기 문서 목록 취득
• 즐겨찾기 상태 취득
• 즐겨찾기 등록

클릭 로그 API

• 클릭 기록

캐시 API

• 캐시된 문서 취득

AI 채팅 API

Chat API

• 개요
• 전제 조건
• 인증과 CSRF
• 속도 제한
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• 보안
• 참고 정보

관리 API

Admin API 레퍼런스

• Admin API 개요
• WebConfig API
• FileConfig API
• DataConfig API
• Documents API
• CrawlingInfo API
• FailureUrl API
• Backup API
• Scheduler API
• JobLog API
• User API
• Role API
• Group API
• AccessToken API
• LabelType API
• KeyMatch API
• BoostDoc API
• ElevateWord API
• BadWord API
• RelatedContent API
• RelatedQuery API
• Suggest API
• General API
• SystemInfo API
• Stats API
• Log API
• Storage API
• Plugin API
• Dict API
• SearchLog API