Geminix.V1beta.GenerateAnswerResponse (geminix v0.2.0)

Response from the model for a grounded answer.

Fields:

:answer (Geminix.V1beta.Candidate.t/0) - Candidate answer from the model. Note: The model always attempts to provide a grounded answer, even when the answer is unlikely to be answerable from the given passages. In that case, a low-quality or ungrounded answer may be provided, along with a low answerable_probability.
:answerable_probability (number/0) - Output only. The model's estimate of the probability that its answer is correct and grounded in the input passages. A low answerable_probability indicates that the answer might not be grounded in the sources. When answerable_probability is low, you may want to: Display a message to the effect of "We couldn’t answer that question" to the user. Fall back to a general-purpose LLM that answers the question from world knowledge. The threshold and nature of such fallbacks will depend on individual use cases. 0.5 is a good starting threshold.
:input_feedback (Geminix.V1beta.InputFeedback.t/0) - Output only. Feedback related to the input data used to answer the question, as opposed to the model-generated response to the question. The input data can be one or more of the following: - Question specified by the last entry in GenerateAnswerRequest.content - Conversation history specified by the other entries in GenerateAnswerRequest.content - Grounding sources (GenerateAnswerRequest.semantic_retriever or GenerateAnswerRequest.inline_passages)

Summary

Types

t()

Functions

from_map(schema \\ %__MODULE__{}, map)

Create a Geminix.V1beta.GenerateAnswerResponse.t/0 from a map returned by the Gemini API.

Types

t()

@type t() :: %Geminix.V1beta.GenerateAnswerResponse{
  __meta__: term(),
  answer: Geminix.V1beta.Candidate.t(),
  answerable_probability: number(),
  input_feedback: Geminix.V1beta.InputFeedback.t()
}

Functions

from_map(schema \\ %MODULE{}, map)

@spec from_map(t(), map()) :: {:ok, t()} | {:error, Ecto.Changeset.t()}

Create a Geminix.V1beta.GenerateAnswerResponse.t/0 from a map returned by the Gemini API.

Sometimes, this function should not be applied to the full response body, but instead it should be applied to the correct part of the map in the response body. This depends on the concrete API call.