Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions deploy/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ SPRING_MAIL_PROPERTIES_MAIL_SMTP_STARTTLS_ENABLE=true
SPRING_MAIL_USERNAME=

AI_SERVER_BASE_URL=http://ai:8000
OPENAI_ENABLED=false
OPENAI_API_KEY=
OPENAI_MODEL=gpt-4o-mini
OPENAI_BASE_URL=https://api.openai.com/v1
OPENAI_TIMEOUT_SECONDS=60

AUTH_EMAIL_FROM_ADDRESS=
AUTH_EMAIL_NOOP_ALLOWED=false
Expand Down
6 changes: 5 additions & 1 deletion deploy/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,11 @@ services:
image: ${AI_IMAGE:-gachi-ai:latest}
container_name: gachi-ai
environment:
OPENAI_API_KEY: ${OPENAI_API_KEY}
OPENAI_ENABLED: ${OPENAI_ENABLED:-false}
OPENAI_API_KEY: ${OPENAI_API_KEY:-}
OPENAI_MODEL: ${OPENAI_MODEL:-gpt-4o-mini}
OPENAI_BASE_URL: ${OPENAI_BASE_URL:-https://api.openai.com/v1}
OPENAI_TIMEOUT_SECONDS: ${OPENAI_TIMEOUT_SECONDS:-60}
healthcheck:
test: ["CMD-SHELL", "curl -fsS http://localhost:8000/ai/health || exit 1"]
interval: 30s
Expand Down
26 changes: 26 additions & 0 deletions docs/newsletter-ai-analyze-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 가정통신문 AI 전체 분석 응답 저장 연동

이 문서는 BE가 AI 서버의 가정통신문 전체 분석 응답을 저장 모델에 반영하는 구현 결정을 정리한다. 상세 API 명세는 노션을 기준으로 관리한다.

## 결정 사항

- BE는 가정통신문 파이프라인의 AI 분석 단계에서 `POST /ai/newsletters/analyze`를 호출한다.
- AI 서버 응답의 top-level `title`, `summary`를 `newsletter.title`, `newsletter.summary`에 저장한다.
- AI 서버 응답의 `items`는 기존 checklist 저장 흐름에 연결한다.
- `dateCandidates` 요청 형식과 `items` 응답 형식은 기존 `extract-items` 계약을 유지한다.
- `meta`는 운영 보조 정보로 받고, 현재 BE 저장 모델에는 직접 저장하지 않는다.
- AI 서버 호출 실패 정책은 `docs/newsletter-ai-failure-policy.md`를 따른다.

## 저장 정책

- `title`: AI 응답 제목을 우선 저장한다. 빈 값이면 기존 BE fallback 제목을 사용한다.
- `summary`: AI 응답 요약을 우선 저장한다. 빈 값이면 기존 BE fallback 요약을 사용한다.
- `items`: `title`이 비어 있지 않은 항목만 checklist로 저장한다.
- `datetime`: TODO 저장 시 `targetDate`, `targetDateLabel` 생성에 사용한다. 파싱 실패 시 날짜 없이 저장한다.
- `dateStatus`: 현재 저장 모델에는 별도 컬럼이 없으므로 직접 저장하지 않는다. 날짜 확정 여부가 필요한 후속 정책은 calendar preview 저장 구조와 함께 별도 이슈에서 다룬다.

## 호환 정책

- AI 서버의 `extract-items` baseline API는 유지하지만, BE 파이프라인은 `analyze`를 우선 사용한다.
- AI 서버가 `items`를 빈 배열로 반환해도 `title`, `summary`는 저장할 수 있다.
- AI 서버 장애 시에는 OCR/번역/dateCandidates 스냅샷을 보존하고 newsletter 상태를 `FAILED`로 둔다.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

Expand All @@ -24,7 +25,7 @@
public class AiNewsletterClient {

private static final ZoneId DEFAULT_ZONE = ZoneId.of("Asia/Seoul");
private static final String EXTRACT_ITEMS_PATH = "/ai/newsletters/extract-items";
private static final String ANALYZE_PATH = "/ai/newsletters/analyze";

private final AiServerProperties aiServerProperties;
private final ObjectMapper objectMapper;
Expand All @@ -39,15 +40,15 @@ public AiNewsletterClient(AiServerProperties aiServerProperties, ObjectMapper ob
.build();
}

public List<ExtractedItem> extractItems(
public AnalysisResponse analyze(
String originalText,
String translatedText,
String language,
List<NewsletterDateCandidate> dateCandidates) {
try {
String requestBody =
objectMapper.writeValueAsString(
new ExtractionRequest(
new AnalysisRequest(
originalText,
translatedText,
language != null ? language : "KO",
Expand All @@ -57,7 +58,7 @@ public List<ExtractedItem> extractItems(

HttpRequest request =
HttpRequest.newBuilder()
.uri(URI.create(normalizedBaseUrl() + EXTRACT_ITEMS_PATH))
.uri(URI.create(normalizedBaseUrl() + ANALYZE_PATH))
.header("Content-Type", "application/json")
.timeout(Duration.ofSeconds(aiServerProperties.getReadTimeoutSeconds()))
.POST(HttpRequest.BodyPublishers.ofString(requestBody))
Expand All @@ -68,16 +69,14 @@ public List<ExtractedItem> extractItems(

if (response.statusCode() < 200 || response.statusCode() >= 300) {
log.error(
"[AiNewsletterClient] AI 서버 항목 추출 실패. status={}, body={}",
"[AiNewsletterClient] AI 서버 분석 실패. status={}, bodyLength={}",
response.statusCode(),
response.body());
response.body() != null ? response.body().length() : 0);
throw new ExternalApiException(
ErrorCode.EXTERNAL_API_ERROR, "AI 서버 항목 추출 실패. status=" + response.statusCode());
ErrorCode.EXTERNAL_API_ERROR, "AI 서버 분석 실패. status=" + response.statusCode());
}

ExtractionResponse extractionResponse =
objectMapper.readValue(response.body(), ExtractionResponse.class);
return extractionResponse.items() != null ? extractionResponse.items() : List.of();
return objectMapper.readValue(response.body(), AnalysisResponse.class).normalized();
} catch (ExternalApiException e) {
throw e;
} catch (InterruptedException e) {
Expand Down Expand Up @@ -119,7 +118,7 @@ private List<DateCandidateRequest> toDateCandidateRequests(
return requests;
}

record ExtractionRequest(
record AnalysisRequest(
String originalText,
String translatedText,
String language,
Expand All @@ -136,12 +135,23 @@ record DateCandidateRequest(
String extractionType) {}

@JsonIgnoreProperties(ignoreUnknown = true)
record ExtractionResponse(List<ExtractedItem> items) {}
public record AnalysisResponse(
String title, String summary, List<ExtractedItem> items, Map<String, Object> meta) {

AnalysisResponse normalized() {
return new AnalysisResponse(title, summary, items != null ? items : List.of(), meta);
}
}

@JsonIgnoreProperties(ignoreUnknown = true)
public record SelectedDateCandidate(
Integer index, String candidateId, String originalText, LocalDate normalizedDate) {}

@JsonIgnoreProperties(ignoreUnknown = true)
public record ExtractedItem(
String type,
String title,
SelectedDateCandidate selectedDateCandidate,
String datetime,
String timezone,
String evidenceText,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import com.gachi.be.domain.checklist.entity.enums.ChecklistType;
import com.gachi.be.domain.checklist.repository.ChecklistRepository;
import com.gachi.be.domain.newsletter.entity.Newsletter;
import com.gachi.be.domain.newsletter.pipeline.AiNewsletterClient.AnalysisResponse;
import com.gachi.be.domain.newsletter.pipeline.AiNewsletterClient.ExtractedItem;
import com.gachi.be.domain.newsletter.repository.NewsletterRepository;
import java.time.LocalDate;
Expand Down Expand Up @@ -39,14 +40,15 @@ public AiAnalysisResult analyze(
new IllegalStateException(
"[AiAnalyzer] newsletter를 찾을 수 없습니다. newsletterId=" + newsletterId));

List<ExtractedItem> items =
aiNewsletterClient.extractItems(
AnalysisResponse analysisResponse =
aiNewsletterClient.analyze(
originalText, translatedText, language, newsletter.getDateCandidates());
List<ExtractedItem> items = analysisResponse.items();

saveExtractedItems(newsletterId, newsletter.getUserId(), items);

String title = inferTitle(originalText);
String summary = buildBaselineSummary(translatedText != null ? translatedText : originalText);
String title = normalizeTitle(analysisResponse.title(), originalText);
String summary = normalizeSummary(analysisResponse.summary(), translatedText, originalText);

log.info(
"[AiAnalyzer] AI 서버 분석 완료. newsletterId={}, extractedItems={}", newsletterId, items.size());
Expand Down Expand Up @@ -109,6 +111,20 @@ private LocalDate parseTargetDate(String value) {
}
}

private String normalizeTitle(String aiTitle, String originalText) {
if (aiTitle != null && !aiTitle.isBlank()) {
return trimToMax(compact(aiTitle), TITLE_MAX_LENGTH);
}
return inferTitle(originalText);
}

private String normalizeSummary(String aiSummary, String translatedText, String originalText) {
if (aiSummary != null && !aiSummary.isBlank()) {
return trimToMax(compact(aiSummary), SUMMARY_MAX_LENGTH);
}
return buildBaselineSummary(firstNonBlank(translatedText, originalText));
}

private String inferTitle(String originalText) {
if (originalText == null || originalText.isBlank()) {
return DEFAULT_TITLE;
Expand All @@ -134,6 +150,10 @@ private String compact(String text) {
return text == null ? "" : text.replaceAll("\\s+", " ").trim();
}

private String firstNonBlank(String primary, String fallback) {
return primary != null && !primary.isBlank() ? primary : fallback;
}

private String trimNullable(String value, int maxLength) {
if (value == null || value.isBlank()) {
return null;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
package com.gachi.be.domain.newsletter.pipeline;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.gachi.be.domain.newsletter.pipeline.AiNewsletterClient.AnalysisResponse;
import com.gachi.be.global.code.ErrorCode;
import com.gachi.be.global.config.external.AiServerProperties;
import com.gachi.be.global.exception.ExternalApiException;
import com.sun.net.httpserver.HttpServer;
import java.io.IOException;
import java.net.InetSocketAddress;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.atomic.AtomicReference;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

class AiNewsletterClientTest {

private HttpServer server;
private ExecutorService executor;

@AfterEach
void tearDown() {
if (server != null) {
server.stop(0);
}
if (executor != null) {
executor.shutdownNow();
}
}

@Test
void analyzeCallsAnalyzeEndpointAndParsesTitleSummaryItems() throws IOException {
AtomicReference<String> requestPath = new AtomicReference<>();
AtomicReference<String> requestBody = new AtomicReference<>();
startServer();
server.createContext(
"/ai/newsletters/analyze",
exchange -> {
requestPath.set(exchange.getRequestURI().getPath());
requestBody.set(
new String(exchange.getRequestBody().readAllBytes(), StandardCharsets.UTF_8));

byte[] response =
"""
{
"title": "AI 제목",
"summary": "AI 요약",
"items": [
{
"type": "checklist",
"title": "동의서 제출",
"selectedDateCandidate": null,
"datetime": "2026-05-25",
"timezone": "Asia/Seoul",
"evidenceText": "5월 25일까지 동의서를 제출해 주세요.",
"dateStatus": "confirmed",
"confidence": 0.9,
"needsUserConfirmation": false,
"confirmationQuestion": null
}
],
"meta": {"mode": "test"}
}
"""
.getBytes(StandardCharsets.UTF_8);
sendResponse(exchange, 200, response);
});

AiNewsletterClient client = newClient(3);

AnalysisResponse response = client.analyze("원문", "번역문", "KO", List.of());

assertThat(requestPath.get()).isEqualTo("/ai/newsletters/analyze");
assertThat(requestBody.get()).contains("\"originalText\":\"원문\"");
assertThat(response.title()).isEqualTo("AI 제목");
assertThat(response.summary()).isEqualTo("AI 요약");
assertThat(response.items()).hasSize(1);
assertThat(response.items().get(0).title()).isEqualTo("동의서 제출");
}

@Test
void analyzeThrowsExternalApiExceptionWhenAiServerReturnsError() throws IOException {
startServer();
server.createContext(
"/ai/newsletters/analyze",
exchange -> sendResponse(exchange, 500, "{\"detail\":\"server error\"}".getBytes()));

AiNewsletterClient client = newClient(3);

assertThatThrownBy(() -> client.analyze("원문", null, "KO", List.of()))
.isInstanceOf(ExternalApiException.class)
.extracting("errorCode")
.isEqualTo(ErrorCode.EXTERNAL_API_ERROR);
}

@Test
void analyzeThrowsExternalApiExceptionWhenAiServerResponseTimesOut() throws IOException {
startServer();
server.createContext(
"/ai/newsletters/analyze",
exchange -> {
try {
Thread.sleep(1500);
sendResponse(exchange, 200, "{}".getBytes(StandardCharsets.UTF_8));
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
}
});

AiNewsletterClient client = newClient(1);

assertThatThrownBy(() -> client.analyze("원문", null, "KO", List.of()))
.isInstanceOf(ExternalApiException.class)
.extracting("errorCode")
.isEqualTo(ErrorCode.EXTERNAL_API_ERROR);
}

@Test
void analyzeThrowsExternalApiExceptionWhenAiServerReturnsMalformedJson() throws IOException {
startServer();
server.createContext(
"/ai/newsletters/analyze",
exchange -> sendResponse(exchange, 200, "{".getBytes(StandardCharsets.UTF_8)));

AiNewsletterClient client = newClient(3);

assertThatThrownBy(() -> client.analyze("원문", null, "KO", List.of()))
.isInstanceOf(ExternalApiException.class)
.extracting("errorCode")
.isEqualTo(ErrorCode.EXTERNAL_API_ERROR);
}

private void startServer() throws IOException {
server = HttpServer.create(new InetSocketAddress("localhost", 0), 0);
executor = Executors.newSingleThreadExecutor();
server.setExecutor(executor);
server.start();
}

private AiNewsletterClient newClient(int readTimeoutSeconds) {
AiServerProperties properties = new AiServerProperties();
properties.setBaseUrl("http://localhost:" + server.getAddress().getPort());
properties.setConnectTimeoutSeconds(3);
properties.setReadTimeoutSeconds(readTimeoutSeconds);
return new AiNewsletterClient(properties, new ObjectMapper().findAndRegisterModules());
}

private void sendResponse(com.sun.net.httpserver.HttpExchange exchange, int status, byte[] body)
throws IOException {
exchange.getResponseHeaders().add("Content-Type", "application/json");
exchange.sendResponseHeaders(status, body.length);
exchange.getResponseBody().write(body);
exchange.close();
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}
Loading