diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chatclient.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chatclient.adoc index e1ea623fb6c..52bdae542aa 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chatclient.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chatclient.adoc @@ -361,6 +361,7 @@ After specifying the `call()` method on `ChatClient`, there are a few different * `String content()`: returns the String content of the response * `ChatResponse chatResponse()`: returns the `ChatResponse` object that contains multiple generations and also metadata about the response, for example how many token were used to create the response. * `ChatClientResponse chatClientResponse()`: returns a `ChatClientResponse` object that contains the `ChatResponse` object and the ChatClient execution context, giving you access to additional data used during the execution of advisors (e.g. the relevant documents retrieved in a RAG flow). +* `ResponseEntity responseEntity()`: returns a `ResponseEntity` containing the full HTTP response, including status code, headers, and body. This is useful when you need access to low-level HTTP details of the response. * `entity()` to return a Java type ** `entity(ParameterizedTypeReference type)`: used to return a `Collection` of entity types. ** `entity(Class type)`: used to return a specific entity type. @@ -368,6 +369,8 @@ After specifying the `call()` method on `ChatClient`, there are a few different You can also invoke the `stream()` method instead of `call()`. +NOTE: Calling the `call()` method does not actually trigger the AI model execution. Instead, it only instructs Spring AI whether to use synchronous or streaming calls. The actual AI model invocation occurs when methods such as `content()`, `chatResponse()`, and `responseEntity()` are called. + == stream() return values After specifying the `stream()` method on `ChatClient`, there are a few options for the response type: