View Javadoc
1   /*
2    * Copyright 2012-2025 CodeLibs Project and the Others.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13   * either express or implied. See the License for the specific language
14   * governing permissions and limitations under the License.
15   */
16  package org.codelibs.fess.llm;
17  
18  /**
19   * Callback interface for receiving streaming chat responses from LLM.
20   */
21  @FunctionalInterface
22  public interface LlmStreamCallback {
23  
24      /**
25       * Called for each chunk of the streaming response.
26       *
27       * @param chunk the text chunk from the LLM response
28       * @param done true if this is the final chunk
29       */
30      void onChunk(String chunk, boolean done);
31  
32      /**
33       * Called when an error occurs during streaming.
34       *
35       * @param error the error that occurred
36       */
37      default void onError(final Throwable error) {
38          // Default implementation does nothing
39      }
40  }