Faqs
FAQ related APIs
이 Method는 유저가 특정 FAQ를 조회하는 것을 시뮬레이션할 때 사용합니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
선택하고 싶은 FAQ의 ID
Q&A 검색 반환 결과의 ID
FAQ 선택 완료
잘못된 FAQ를 제공할 경우
POST /webapi/faq/select_answer HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"id": "text",
"hashId": "text"
}{
"result": "text"
}이 API를 사용하면 Q&A 지식베이스에서 가장 관련성 높은 질문과 답변 쌍을 찾을 수 있습니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
기본 값은 true입니다. 이 옵션이 false로 설정되면, 주어진 쿼리에 대한 답변이 없을 때 쿼리를 자동으로 후보에게 등록하지 않습니다.
AND 또는 OR.
모든 결과에 모든 해시태그가 포함되기를 원하면 AND를 선택해 주세요.
모든 결과에 적어도 하나의 해시태그가 포함되기를 원하면 OR을 선택해 주세요.
표시하고 싶은 모든 해시태그의 배열.
반환할 최대 결과 수.
쿼리 문자열입니다.
텍스트인지 html인지 여부. 텍스트인 경우 반환 값은 일반 텍스트입니다. html인 경우 html로 반환됩니다. 답변에 다른 폰트 크기와 색상이 있는 스타일이 적용된 html이 포함된 경우 html을 사용할 수 있습니다. 단순히 텍스트로 답변을 얻고 싶다면 텍스트를 사용할 수 있습니다. 기본값은 html입니다.
API는 Q&A 데이터베이스에서 가장 관련성 있는 질문과 답변을 찾을 것입니다.
POST /webapi/faq HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"autoRegisterCandidates": true,
"hashtagsOperator": "AND",
"hashtags": [
"text"
],
"maxResults": 1,
"query": "text",
"format": "html"
}API는 Q&A 데이터베이스에서 가장 관련성 있는 질문과 답변을 찾을 것입니다.
{
"result": [
{
"confidence": 1,
"effectiveConfidence": 1,
"question": "text",
"answer": "text",
"id": "text",
"hashtags": [
"text"
],
"lastUpdatedDate": "2025-08-28",
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
],
"count": 1,
"hashId": "text"
}단일 Q&A의 모든 세부 정보를 가져오는 방법입니다.
The id of the FAQ you are looking for.
The format of the answer value for this FAQ. Default is HTML.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
FAQ 세부정보를 성공적으로 검색했습니다.
FAQ를 찾을 수 없습니다
GET /webapi/single_faq HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"question": "text",
"similar_questions": [
"text"
],
"answer": "text",
"id": "text",
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"lastUpdatedDate": "2025-08-28",
"createdDate": "2025-08-28",
"hashtags": [
"text"
],
"statusOnAt": "2025-08-28T00:03:32.004Z",
"statusOffAt": "2025-08-28T00:03:32.004Z",
"folder": "text",
"agentEditor": [
"text"
],
"agentViewer": [
"text"
],
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}
}이 API를 사용하여 지식베이스에서 Q&A를 가져올 수 있습니다.
Offset allows you to specify the ranking number of the first item on the page.
0Limit allows you to set the number of objects returned on one page. The maximum and the default value is 1000.
1000If your answers contain styled html, such as different font size or color, you can use html to get answers in html format. If you simply want to get answers as a text, you can use the text.
htmlPossible values: Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
FAQ를 성공적으로 가져왔습니다.
GET /webapi/faqs HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
FAQ를 성공적으로 가져왔습니다.
{
"offset": 1,
"count": 1,
"total_count": 1,
"results": [
{
"id": "text",
"question": "text",
"answer": "text",
"hashtags": [
"text"
],
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"lastUpdatedDate": "2025-08-28",
"createdDate": "2025-08-28"
}
]
}이 API를 사용하여 지식베이스에서 Q&A를 검색하고 필터링할 수 있습니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
목록을 필터링하기 위한 키워드 검색 쿼리입니다. 연산자를 사용하여 고급 검색을 실행할 수 있습니다. "TERM1 TERM2"는 AND, "TERM1 OR TERM2"는 OR, "TERM"은 정확히 일치하는 검색에 사용됩니다.
True일 경우, 활성화된 Q&A만 나열되고, False일 경우, 비활성화된 Q&A만 표시됩니다.
목록을 필터링하기 위한 해시태그. 여러 개의 해시태그를 추가할 수 있습니다.
해시태그가 "and"이면, 여러 개의 해시태그 필터는 AND 논리로 작동합니다. "or"이면, OR 논리로 작동합니다.
True인 경우, 목록에는 에이전트가 작성한 Q&A만 포함됩니다. False인 경우, 다른 Q&A만 포함됩니다. createdByAgent, answeredByMrc, autoGenerated, editedByAgent 필터는 상호 배타적이며, 두 개 이상의 필터가 사용되면 OR 논리가 적용됩니다.
True인 경우, 목록에는 업로드된 문서에서 자동으로 추출된 답변인 Q&A만 포함됩니다. False인 경우, 다른 Q&A만 포함됩니다.
True이면 목록에는 자동 생성된 Q&A만 포함됩니다. False이면 다른 Q&A만 포함됩니다.
True일 경우, 목록에는 등록 후 어떤 에이전트에 의해 편집된 Q&A만 포함됩니다. False일 경우, 다른 Q&A만 포함됩니다.
답변에 다양한 글꼴 크기나 색상과 같은 스타일이 있는 HTML이 포함되어 있다면, HTML 형식을 사용하여 답변을 받을 수 있습니다. 단순히 텍스트로 답변을 받고 싶다면, 텍스트를 사용할 수 있습니다. 기본값은 HTML입니다.
Offset은 페이지에서 첫 번째 항목의 순위 번호를 지정할 수 있게 합니다.
제한은 한 페이지에 반환되는 객체 수를 설정할 수 있게 해줍니다. 최대값과 기본값은 1000입니다.
FAQ 검색 성공
POST /webapi/faqs HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 202
{
"searchTerm": "text",
"isUsed": true,
"hashtags": [
"text"
],
"hashtagsOperator": "and",
"createdByAgent": true,
"answeredByMrc": true,
"autoGenerated": true,
"editedByAgent": true,
"format": "html",
"offset": 1,
"limit": 1
}FAQ 검색 성공
{
"offset": 1,
"count": 1,
"total_count": 1,
"results": [
{
"id": "text",
"question": "text",
"answer": "text",
"hashtags": [
"text"
],
"userFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
},
"lastUpdatedDate": "2025-08-28",
"createdDate": "2025-08-28"
}
]
}이 API를 사용하여 새로운 Q&A를 추가하거나 기존 Q&A를 업데이트할 수 있습니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Q&A의 질문 부분.
같은 답을 가지고 있는 유사한 질문들.
Q&A의 답변 부분. 데이터베이스에 동일한 질문이 존재하는 경우, 해당 답변이 기존 답변을 대체합니다.
Q&A에 해시태그 추가됨.
켜짐 또는 꺼짐. 켜짐으로 설정하면, 등록된 Q&A가 Q&A 검색에 활성화됩니다.
에이전트와 공유할 Q&A에 대한 메모.
FAQ 생성이 완료되었습니다.
POST /webapi/register_faq HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 192
{
"question": "text",
"similarQuestions": [
"text"
],
"answer": "text",
"hashtags": [
"text"
],
"status": true,
"memo": "text",
"target_folder_id": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}FAQ 생성이 완료되었습니다.
{
"result": {
"status": "text",
"id": "text"
},
"errors": "text"
}이 API를 사용하여 기존 Q&A를 업데이트할 수 있습니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
업데이트할 Q&A의 ID.
Q&A의 질문 부분.
같은 답을 가진 유사한 질문들.
Q&A의 답변 부분.
Q&A에 해시태그 추가됨.
켜짐 또는 꺼짐. 켜짐으로 설정하면 Q&A 검색에 Q&A가 활성화됩니다.
FAQ가 성공적으로 업데이트되었습니다.
PUT /webapi/register_faq HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191
{
"id": "text",
"question": "text",
"similar_questions": [
"text"
],
"answer": "text",
"hashtags": [
"text"
],
"status": true,
"target_folder_id": "text",
"allowOtherAgentsView": true,
"allowOtherUsersView": true
}FAQ가 성공적으로 업데이트되었습니다.
{
"result": {
"status": "text",
"id": "text"
},
"errors": "text"
}이 API를 사용하여 Q&A를 삭제할 수 있습니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
삭제하려는 Q&A의 ID.
자주 묻는 질문이 성공적으로 삭제되었습니다.
FAQ를 찾을 수 없습니다.
POST /webapi/delete_faq HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}{
"result": {
"status": "text"
},
"errors": "text"
}이 API를 사용하여 tsv, csv, xlsx 및 zip 형식으로 여러 Q&A를 업로드할 수 있습니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
로컬 Q&A 파일 위치입니다. xlsx, tsv, csv, zip 파일이 지원됩니다.
FAQ 파일 업로드 성공
잘못된 매개변수
POST /webapi/upload_faq_file HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17
{
"file": "binary"
}{
"result": "text",
"notUploaded": [
{
"question": "text",
"state": "text"
}
]
}This API lets you give or cancel feedback given to a Q&A pair for a search query.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Your API key can be found in your dashboard Settings menu, under the General tab.
The query you want to give or cancel feedback for, toward the Q&A.
The ID for the Q&A you want to give or cancel feedback for the query. It is created whenever a Q&A search happens and bound to the query and the Q&A pair. It can be retrieved using the Q&A API above.
When the value is true, positive feedback is given to the Q&A for the query. When it's false, negative feedback is given. When it's null, it cancels the feedback.
Feedback submitted successfully
POST /webapi/faq_feedback HTTP/1.1
Host: backend.alli.ai
API-KEY: text
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"query": "text",
"id": "text",
"isPositive": true
}Feedback submitted successfully
{
"result": {
"faqTrainSearchResult": {
"faq": {
"id": "text"
},
"agentFeedback": {
"positiveCount": 1,
"negativeCount": 1
}
}
},
"errors": {}
}REST API와 Alli 대시보드를 통해 수행된 과거 Q&A 검색 결과를 반환합니다.
A limit on the number of results to show (used for pagination)
In the list of all results, the index from which to start listing results (used for pagination)
The latest date from which you want to get history (dates should be in the form YYYY-MM-DD)
The earliest date from which you want to get history (dates should be in the form YYYY-MM-DD)
Can either be DESC (meaning latest queries come first), or ASC (meaning earliest queries come first)
The term that should have appeared in the query
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
성공적인 대응
GET /webapi/faq_histories HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
성공적인 대응
{
"result": {
"histories": [
{
"agent": {
"id": "text"
},
"question": "text",
"answers": [
{
"faq": {
"id": "text"
},
"effectiveConfidence": 1,
"confidence": 1
}
]
}
],
"count": 1
},
"errors": {}
}이 API를 사용하여 멤버의 미답변 질문 목록을 얻을 수 있습니다. 미답변 질문 목록은 Alli 내에서 '후보'로 명명됩니다.
Hashtag array if you want to limit the search scope to the given hashtags
Search query to filter the candidates to see. You can use operators to run advanced searches. "TERM1 TERM2" for AND, "TERM1 OR TERM2" for OR, and "TERM" for exact match.
How to order the candidates. You can use ATTRIBUTE_[DESC or ASC] format. ATTRIBUTE can be FREQUENCY or CREATED_AT.
Status of the candidates to see. It can be ALL or ACTIVE or ARCHIVED.
offset allows you to specify the ranking number of the first item on the page.
limit allows you to set the number of objects returned on one page. The maximum value is 100.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
성공적인 답변
GET /webapi/faq_candidates HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
성공적인 답변
{
"result": {
"faqCandidates": [
{
"id": "text",
"frequency": 1,
"textAnswer": "text",
"state": "text",
"createdAt": 1,
"questions": [
{
"id": "text",
"question": "text",
"frequency": 1,
"history": {
"id": "text"
}
}
]
}
],
"count": 1
},
"errors": {}
}지정된 날짜 범위 내에서 FAQ의 Q&A 일일 트렌드.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
YYYY-MM-DD 형식의 조회할 날짜 범위의 시작.
YYYY-MM-DD 형식으로 조회할 날짜 범위의 끝.
성공적으로 일일 FAQ 수를 검색했습니다.
GET /webapi/faq_daily_count HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"startDate": "text",
"endDate": "text"
}성공적으로 일일 FAQ 수를 검색했습니다.
{
"result": {
"dailyTotalCount": [
{
"date": "text",
"count": 1
}
],
"state": "text",
"campaignCount": 1
},
"errors": {}
}가장 자주 묻는 Q&A에 대한 분석 정보.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
가장 자주 묻는 질문과 답변의 상위 N개. N의 최대값은 20입니다. N으로 1, 5, 10 또는 20을 사용해 주세요.
YYYY-MM-DD 형식의 조회할 날짜 범위의 시작.
YYYY-MM-DD 형식으로 조회할 날짜 범위의 종료일.
FAQ 분석을 성공적으로 가져왔습니다.
GET /webapi/faq_daily_analytics HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46
{
"topN": 1,
"startDate": "text",
"endDate": "text"
}FAQ 분석을 성공적으로 가져왔습니다.
{
"result": {
"faqDailyAnalytics": [
{
"totalCount": 1,
"totalShownCount": 1,
"selectedRatio": 1,
"faq": {
"id": "text",
"question": "text"
},
"stats": [
{
"date": "text",
"selectedCount": 1
}
]
}
]
},
"errors": {}
}시스템에 새로운 Q&A 후보를 등록합니다.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
등록하고자 하는 모든 쿼리 목록
후보 등록 완료
POST /webapi/add_faq_candidates HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"queries": [
"text"
]
}후보 등록 완료
{
"result": {
"candidates": [
{
"id": "text"
}
]
},
"errors": {}
}Was this helpful?