Package com.oracle.bmc.generativeaiinference.model

Class Summary

Class	Description
AssistantMessage	Represents a single instance of assistant message.
AssistantMessage.Builder
BaseChatRequest	The base class to use for the chat inference request.
BaseChatResponse	The base class that creates the chat response.
ChatChoice	Represents a single instance of the chat response.
ChatChoice.Builder
ChatContent	The base class for the chat content.
ChatDetails	Details of the conversation for the model to respond.
ChatDetails.Builder
ChatResult	The response to the chat conversation.
ChatResult.Builder
Choice	Represents a single instance of the generated text.
Choice.Builder
Citation	A section of the generated response which cites the documents that were used for generating the response.
Citation.Builder
CohereChatBotMessage	A message that represents a single chat dialog as CHATBOT role.
CohereChatBotMessage.Builder
CohereChatRequest	Details for the chat request for Cohere models.
CohereChatRequest.Builder
CohereChatResponse	The response to the chat conversation.
CohereChatResponse.Builder
CohereLlmInferenceRequest	Details for the text generation request for Cohere models.
CohereLlmInferenceRequest.Builder
CohereLlmInferenceResponse	The generated text result to return.
CohereLlmInferenceResponse.Builder
CohereMessage	A message that represents a single chat dialog.
CohereParameterDefinition	A definition of tool parameter.
CohereParameterDefinition.Builder
CohereResponseFormat	Specify the format the model output is guaranteed to be of Note: Objects should always be created or deserialized using the Builder.
CohereResponseJsonFormat	The json object format for the model structured output Note: Objects should always be created or deserialized using the CohereResponseJsonFormat.Builder.
CohereResponseJsonFormat.Builder
CohereResponseTextFormat	The text format for cohere model response Note: Objects should always be created or deserialized using the CohereResponseTextFormat.Builder.
CohereResponseTextFormat.Builder
CohereSystemMessage	A message that represents a single chat dialog as SYSTEM role.
CohereSystemMessage.Builder
CohereTool	A definition of tool (function).
CohereTool.Builder
CohereToolCall	A tool call generated by the model.
CohereToolCall.Builder
CohereToolMessage	A message that represents a single chat dialog as TOOL role.
CohereToolMessage.Builder
CohereToolResult	The result from invoking tools recommended by the model in the previous chat turn.
CohereToolResult.Builder
CohereUserMessage	A message that represents a single chat dialog as USER role.
CohereUserMessage.Builder
DedicatedServingMode	The model’s serving mode is dedicated serving and has an endpoint on a dedicated AI cluster.
DedicatedServingMode.Builder
Document	The input of the document to rerank.
Document.Builder
DocumentRank	An object that contains a relevance score, an index and the text for a document.
DocumentRank.Builder
EmbedTextDetails	Details for the request to embed texts.
EmbedTextDetails.Builder
EmbedTextResult	The generated embedded result to return.
EmbedTextResult.Builder
FunctionCall	The function call generated by the model.
FunctionCall.Builder
FunctionDefinition	A function the model may call.
FunctionDefinition.Builder
GeneratedText	The text generated during each run.
GeneratedText.Builder
GenerateTextDetails	Details for the request to generate text.
GenerateTextDetails.Builder
GenerateTextResult	The generated text result to return.
GenerateTextResult.Builder
GenericChatRequest	Details for the chat request.
GenericChatRequest.Builder
GenericChatResponse	The response for a chat conversation.
GenericChatResponse.Builder
ImageContent	Represents a single instance of chat image content.
ImageContent.Builder
ImageUrl	Provide a base64 encoded image.
ImageUrl.Builder
LlamaLlmInferenceRequest	Details for the text generation request for Llama models.
LlamaLlmInferenceRequest.Builder
LlamaLlmInferenceResponse	The generated text result to return.
LlamaLlmInferenceResponse.Builder
LlmInferenceRequest	The base class for the inference requests.
LlmInferenceResponse	The base class for inference responses.
Logprobs	Includes the logarithmic probabilities for the most likely output tokens and the chosen tokens.
Logprobs.Builder
Message	A message that represents a single chat dialog.
OnDemandServingMode	The model’s serving mode is on-demand serving on a shared infrastructure.
OnDemandServingMode.Builder
RerankTextDetails	Details required for a rerank request.
RerankTextDetails.Builder
RerankTextResult	The rerank response to return to the caller.
RerankTextResult.Builder
SearchQuery	The generated search query.
SearchQuery.Builder
ServingMode	The model’s serving mode, which is either on-demand serving or dedicated serving.
SummarizeTextDetails	Details for the request to summarize text.
SummarizeTextDetails.Builder
SummarizeTextResult	Summarize text result to return to caller.
SummarizeTextResult.Builder
SystemMessage	Represents a single instance of system message.
SystemMessage.Builder
TextContent	Represents a single instance of text in the chat content.
TextContent.Builder
TokenLikelihood	An object that contains the returned token and its corresponding likelihood.
TokenLikelihood.Builder
ToolCall	The tool call generated by the model, such as function call.
ToolChoice	The tool choice for a tool.
ToolChoiceAuto	The model can pick between generating a message or calling one or more tools.
ToolChoiceAuto.Builder
ToolChoiceFunction	The tool choice for a function.
ToolChoiceFunction.Builder
ToolChoiceNone	The model will not call any tool and instead generates a message.
ToolChoiceNone.Builder
ToolChoiceRequired	The model must call one or more tools.
ToolChoiceRequired.Builder
ToolDefinition	A tool the model may call.
ToolMessage	Represents a single instance of tool message.
ToolMessage.Builder
UserMessage	Represents a single instance of user message.
UserMessage.Builder

Enum Summary

Enum	Description
BaseChatRequest.ApiFormat	The API format for the model’s family group.
BaseChatResponse.ApiFormat	The API format for the model’s response.
ChatContent.Type	The type of the content.
CohereChatRequest.CitationQuality	When FAST is selected, citations are generated at the same time as the text output and the request will be completed sooner.
CohereChatRequest.PromptTruncation	Defaults to OFF.
CohereChatResponse.FinishReason	Why the generation stopped.
CohereLlmInferenceRequest.ReturnLikelihoods	Specifies how and if the token likelihoods are returned with the response.
CohereLlmInferenceRequest.Truncate	For an input that’s longer than the maximum token length, specifies which part of the input text will be truncated.
CohereMessage.Role	To identify who the message is coming from, a role is associated to each message.
CohereResponseFormat.Type	The format type
EmbedTextDetails.InputType	Specifies the input type.
EmbedTextDetails.Truncate	For an input that’s longer than the maximum token length, specifies which part of the input text will be truncated.
ImageUrl.Detail	The default value is AUTO and only AUTO is supported.
LlmInferenceRequest.RuntimeType	The runtime of the provided model.
LlmInferenceResponse.RuntimeType	The runtime of the provided model.
Message.Role	Indicates who is writing the current chat message.
ServingMode.ServingType	The serving mode type, which is either on-demand serving or dedicated serving.
SummarizeTextDetails.Extractiveness	Controls how close to the original text the summary is.
SummarizeTextDetails.Format	Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points.
SummarizeTextDetails.Length	Indicates the approximate length of the summary.
ToolCall.Type	The type of the tool.
ToolChoice.Type	The tool choice.
ToolDefinition.Type	The type of the tool.