GenerativeAIFunctionRequest.EvaluatedResponse (FirstSpirit Access-API)

All Known Subinterfaces:: GenerativeAIFunctionRequest.EvaluatedResponseStream

Enclosing interface:: GenerativeAIFunctionRequest

public static interface GenerativeAIFunctionRequest.EvaluatedResponse

Evaluated response of the generative AI, potentially containing function call requests.

Since:: 5.2.250908

Method Summary

Modifier and Type

Method

Description

@NotNull Request

createRequest()

Creates a new request using the previously evaluated function calls.

@NotNull List<GenerativeAIFunctionRequest.FunctionCallHandle>

getFunctionCallHandles()

Returns a list of function calls requested by the AI.

@NotNull Response

getResponse()

The response object returned by the generative AI.

Method Details
- getResponse
  
  @NotNull @NotNull Response getResponse()
  
  The response object returned by the generative AI.
  
  Returns:
  
  The response object.
  
  Since:
  
  5.2.250908
- getFunctionCallHandles
  
  @NotNull @NotNull List<GenerativeAIFunctionRequest.FunctionCallHandle> getFunctionCallHandles()
  
  Returns a list of function calls requested by the AI.
  
  Returns:
  
  The list of function calls.
  
  Since:
  
  5.2.250908
- createRequest
  
  @NotNull @NotNull Request createRequest()
  
  Creates a new request using the previously evaluated function calls. Any skipped function call will not be contained in the resulting request. Usually the caller of this method should make sure to perform all function calls.
  
  Returns:
  
  The new request to be used with the contextual GenerativeAIFunctionRequest.
  
  Since:
  
  5.2.250908