Package de.xima.fc.prompt.ms.impl.service.generic_oai.client.json

Internal package containing the model classes for the JSON request and response payloads for the generic OAI REST API. Uses Jackson to serialize and deserialize the JSON data.

Since:

8.5.0

Class Summary

Class	Description
ApiChatCompletionsRequest
ApiChatCompletionsRequestMessage
ApiChatCompletionsRequestMessage.Developer	Developer-provided instructions that the model should follow, regardless of messages sent by the user.
ApiChatCompletionsRequestMessage.Function	A function message with the results of a function call.
ApiChatCompletionsRequestMessage.System	Developer-provided instructions that the model should follow, regardless of messages sent by the user.
ApiChatCompletionsRequestMessage.Tool	A tool message with the results of a tool call.
ApiChatCompletionsRequestMessage.User	Messages sent by an end user, containing prompts or additional context information.
ApiChatCompletionsRequestMessageContent
ApiChatCompletionsRequestMessageContent.Audio	Audio content for the message.
ApiChatCompletionsRequestMessageContent.File	File content for the message.
ApiChatCompletionsRequestMessageContent.Image	Image content for the message.
ApiChatCompletionsRequestMessageContent.Text	Text content for the message.
ApiChatCompletionsRequestMessageContentFile	File content for the chat completions message content.
ApiChatCompletionsRequestMessageContentImageUrl	An image URL content for the chat completions message content.
ApiChatCompletionsRequestMessageContentInputAudio	Audio input content for the chat completions message content.
ApiChatCompletionsRequestResponseFormat	Represents the response format for chat completions.
ApiChatCompletionsRequestResponseFormat.JsonObject	JSON object response format.
ApiChatCompletionsRequestResponseFormat.JsonSchema	JSON schema response format.
ApiChatCompletionsRequestResponseFormat.Text	Plain text response format.
ApiChatCompletionsRequestResponseFormatJsonSchema	Represents the JSON schema for the response format in chat completions.
ApiChatCompletionsResponse	Represents a chat completion response returned by model, based on the provided input.
ApiChatCompletionsResponseChoice	A chat completion choices returned by the chat completion endpoint.
ApiChatCompletionsResponseChoiceLogProbs	Log probability information for the choice.
ApiChatCompletionsResponseChoiceLogProbsContentTopLogProbs	A token and its log probability.
ApiChatCompletionsResponseChoiceLogProbsTokenInfo	Content tokens with log probability information.
ApiChatCompletionsResponseChoiceMessage	A chat completion message generated by the model.
ApiChatCompletionsResponseMessageAnnotation	Annotations for the message, when applicable, as when using the web search tool.
ApiChatCompletionsResponseMessageAnnotationUrlCitation	A URL citation when using web search.
ApiChatCompletionsResponseMessageAudio	If the audio output modality is requested, this object contains data about the audio response from the model.
ApiChatCompletionsResponseMessageToolCall	A tool call generated by the model, such as a function call.
ApiChatCompletionsResponseMessageToolCall.Custom	A call to a custom tool created by the model.
ApiChatCompletionsResponseMessageToolCall.Function	A call to a function tool created by the model.
ApiChatCompletionsResponseMessageToolCallCustom	A call to a custom tool created by the model.
ApiChatCompletionsResponseMessageToolCallFunction	The function that the model called.
ApiChatCompletionsResponseUsage	Usage statistics for the completion request.
ApiChatCompletionsResponseUsageCompletionTokenDetails	Breakdown of tokens used in a completion.
ApiChatCompletionsResponseUsagePromptTokenDetails	Breakdown of tokens used in the prompt.
ApiModelsResponse
ApiModelsResponseModel	A single model that can be used when prompting.
FileContentBase64Deserializer	Deserializer for FileContent that reads the data from a base64 encoded string in the JSON.
FileContentBase64Serializer
FileContentBase64UrlSerializer	Serializer for FileContent that encodes the content as a base64 URL, i.e.
RawJsonStringSerializer	Serializer for String that assumes the string already represents a valid JSON string.
TempFolderStorage