이 페이지에서
> 리소스 > 문서 > api > API 참조: 검색

API 참조: 검색

검색 엔드포인트는 테넌트 콘텐츠 전체를 대상으로 전역 의미 검색을 수행합니다. 무료 체험을 이용해 사용자 워크스페이스에서 직접 테스트할 수 있습니다.

테넌트의 역할, 프로세스, 요소, 문서, 버전 및 댓글 전체 검색

테넌트별 요청 제한이 적용됩니다. 429 응답에는 공통 메시지 본문({“message”: “Too many search requests, please slow down.”})이 포함됩니다.

엔드포인트: POST /v1/tenant/{tenantId}/search

인증: 테넌트 범위 API 키 · read 범위

매개변수:

이름 유형 위치 필수 설명
tenantId string 경로 예 형식: uuid

요청 본문:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
필드 유형 필수 설명
query string 예 검색어
최대 길이: 1000
mode semantic | exact | hybrid 아니요 semantic = 임베딩 기반, exact = 정확히 일치, hybrid = 두 방식 모두
허용 값: semantic, exact, hybrid
기본값: hybrid
categories role | process | element | documentation | version | comment[] 아니요 지정한 카테고리로 결과 제한
processId string 아니요 단일 프로세스의 결과만 조회
형식: uuid
k integer 아니요 반환할 결과 수
기본값: 20
최솟값: 1
최댓값: 50

응답(200):

검색 결과(일치 항목, 개수, 전체 수, 추천 검색어)

{
	"hits": [
		{
			"category": "role",
			"entityType": "role",
			"entityId": "string",
			"subKey": "string",
			"title": "string",
			"snippet": "string",
			"score": 0,
			"processId": "00000000-0000-0000-0000-000000000000",
			"processDisplayName": "string",
			"elementType": "string",
			"docSection": "string",
			"url": "string"
		}
	],
	"counts": {},
	"total": 0,
	"suggestions": [
		"string"
	]
}
필드 유형 필수 설명
hits object[] 예
counts object 예
total number 예
suggestions string[] 예

오류:

  • 401 API 키가 없거나 유효하지 않거나 비활성화 또는 만료된 경우
  • 429 요청 제한 초과: 엔드포인트 문서에 명시된 요청 제한을 확인하세요

관련 문서

더 나은 프로세스를 설계하고, 연결된 아키텍처를 구축해 관리하세요.

신용카드 등록이나 대기 없이 바로 이용할 수 있습니다. 조직의 업무 방식을 명확하고 유기적으로 연결된 프로세스 설계로 바꿔 보세요.

프로세스 아키텍처를 구축하고, 소유권과 통제 기준을 정립하며, 모든 계층의 역할과 책임을 조율하세요.

무료 체험을 시작하고 프로세스를 관리·운영하고 지속적으로 개선할 수 있는 신뢰할 만한 기반을 마련하세요.

오늘 무료 체험 시작하기