package org.codelibs.fess.llm;

import java.util.List;
import java.util.Map;

/**
 * Interface for LLM (Large Language Model) clients.
 * Implementations provide integration with different LLM providers
 * such as Ollama, OpenAI, and Google Gemini.
 *
 * In addition to low-level chat operations, this interface defines
 * high-level RAG workflow methods that allow each provider to optimize
 * prompt construction, parameter tuning, and response parsing.

        assertEquals("ollama", searchLog.getAccessType());
    }

    @Test
    public void test_addSearchLog_accessType_openai() {
        final SearchLog searchLog = callCreateSearchLogAndGetResult("openai");
        assertEquals("openai", searchLog.getAccessType());
    }

    @Test
    public void test_addSearchLog_accessType_gemini() {
        final SearchLog searchLog = callCreateSearchLogAndGetResult("gemini");

        assertEquals("ollama", request.getAttribute(Constants.SEARCH_LOG_ACCESS_TYPE));

        request.setAttribute(Constants.SEARCH_LOG_ACCESS_TYPE, "openai");
        assertEquals("openai", request.getAttribute(Constants.SEARCH_LOG_ACCESS_TYPE));
    }

    @Test
    public void test_accessType_constantValues() {
        assertEquals("json", Constants.SEARCH_LOG_ACCESS_TYPE_JSON);

        return null;
    }

    /**
     * Gets the configured LLM type from the system configuration.
     *
     * @return The LLM type string from configuration (e.g., "ollama", "openai", "gemini")
     */
    protected String getLlmType() {
        return ComponentUtil.getFessConfig().getSystemProperty("rag.llm.name", "ollama");
    }

    /**
     * Checks if RAG chat feature is enabled.

    /**
     * Gets the configuration prefix for this provider.
     * Used to look up per-prompt-type parameters from FessConfig.
     *
     * @return the config prefix (e.g. "rag.llm.openai")
     */
    protected abstract String getConfigPrefix();

    /**
     * Gets the base system prompt for RAG chat responses.
     *
     * @return the system prompt
     */

## **FastAPI**와 OpenAPI로 webhooks 문서화하기 { #documenting-webhooks-with-fastapi-and-openapi }

**FastAPI**에서는 OpenAPI를 사용해, 이러한 webhook의 이름, 여러분의 앱이 보낼 수 있는 HTTP 작업 타입(예: `POST`, `PUT` 등), 그리고 여러분의 앱이 보낼 요청 **본문(body)**을 정의할 수 있습니다.

이렇게 하면 사용자가 여러분의 **webhook** 요청을 받기 위해 **자신들의 API를 구현**하기가 훨씬 쉬워지고, 경우에 따라서는 자신의 API 코드 일부를 자동 생성할 수도 있습니다.

/// info | 정보

Webhooks는 OpenAPI 3.1.0 이상에서 사용할 수 있으며, FastAPI `0.99.0` 이상에서 지원됩니다.

# OpenAPI condicional { #conditional-openapi }

Se necessário, você pode usar configurações e variáveis de ambiente para configurar o OpenAPI condicionalmente dependendo do ambiente e até mesmo desativá-lo completamente.

## Sobre segurança, APIs e documentação { #about-security-apis-and-docs }

Ocultar suas interfaces de usuário de documentação na produção não *deveria* ser a maneira de proteger sua API.

Existem alguns casos em que pode ser necessário modificar o esquema OpenAPI gerado.

Nesta seção, você verá como fazer isso.

## O processo normal { #the-normal-process }

O processo normal (padrão) é o seguinte:

Uma aplicação (instância) do `FastAPI` possui um método `.openapi()` que deve retornar o esquema OpenAPI.

## Documentando webhooks com o **FastAPI** e OpenAPI { #documenting-webhooks-with-fastapi-and-openapi }

Com o **FastAPI**, utilizando o OpenAPI, você pode definir os nomes destes webhooks, os tipos das operações HTTP que a sua aplicação pode enviar (e.g. `POST`, `PUT`, etc.) e os **corpos** da requisição que a sua aplicação enviaria.

* Ela não necessita ter nenhum código real, porque seu aplicativo nunca chamará esse código. Ele é usado apenas para documentar a *API externa*. Então, a função poderia ter apenas `pass`.