Uses of Class
com.azure.ai.openai.models.ChatCompletionsOptions

Packages that use ChatCompletionsOptions

Package	Description
com.azure.ai.openai	Package containing the classes for OpenAI.
com.azure.ai.openai.models	Package containing the data models for OpenAI.

Uses of ChatCompletionsOptions in com.azure.ai.openai

Methods in com.azure.ai.openai with parameters of type ChatCompletionsOptions

Modifier and Type	Method	Description
Mono<ChatCompletions>	OpenAIAsyncClient.getChatCompletions(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)	Gets chat completions for the provided chat messages.
ChatCompletions	OpenAIClient.getChatCompletions(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)	Gets chat completions for the provided chat messages.
Flux<ChatCompletions>	OpenAIAsyncClient.getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)	Gets chat completions for the provided chat messages.
Flux<ChatCompletions>	OpenAIAsyncClient.getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, ChatCompletionStreamOptions streamOptions)	Gets chat completions for the provided chat messages.
com.azure.core.util.IterableStream<ChatCompletions>	OpenAIClient.getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions)	Gets chat completions for the provided chat messages in streaming mode.
com.azure.core.util.IterableStream<ChatCompletions>	OpenAIClient.getChatCompletionsStream(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, ChatCompletionStreamOptions streamOptions)	Gets chat completions for the provided chat messages in streaming mode.
Flux<com.azure.core.http.rest.Response<ChatCompletions>>	OpenAIAsyncClient.getChatCompletionsStreamWithResponse(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, com.azure.core.http.rest.RequestOptions requestOptions)	Gets chat completions for the provided chat messages.
com.azure.core.http.rest.Response<com.azure.core.util.IterableStream<ChatCompletions>>	OpenAIClient.getChatCompletionsStreamWithResponse(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, com.azure.core.http.rest.RequestOptions requestOptions)	Gets chat completions for the provided chat messages in streaming mode.
Mono<com.azure.core.http.rest.Response<ChatCompletions>>	OpenAIAsyncClient.getChatCompletionsWithResponse(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, com.azure.core.http.rest.RequestOptions requestOptions)	Gets chat completions for the provided chat messages.
com.azure.core.http.rest.Response<ChatCompletions>	OpenAIClient.getChatCompletionsWithResponse(String deploymentOrModelName, ChatCompletionsOptions chatCompletionsOptions, com.azure.core.http.rest.RequestOptions requestOptions)	Gets chat completions for the provided chat messages.

Uses of ChatCompletionsOptions in com.azure.ai.openai.models

Methods in com.azure.ai.openai.models that return ChatCompletionsOptions

Modifier and Type	Method	Description
static ChatCompletionsOptions	ChatCompletionsOptions.fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of ChatCompletionsOptions from the JsonReader.
ChatCompletionsOptions	ChatCompletionsOptions.setDataSources(List<AzureChatExtensionConfiguration> dataSources)	Set the dataSources property: The configuration entries for Azure OpenAI chat extensions that use them.
ChatCompletionsOptions	ChatCompletionsOptions.setEnhancements(AzureChatEnhancementConfiguration enhancements)	Set the enhancements property: If provided, the configuration options for available Azure OpenAI chat enhancements.
ChatCompletionsOptions	ChatCompletionsOptions.setFrequencyPenalty(Double frequencyPenalty)	Set the frequencyPenalty property: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text.
ChatCompletionsOptions	ChatCompletionsOptions.setFunctionCall(FunctionCallConfig functionCallConfig)	Set the functionCall property: Controls how the model responds to function calls.
ChatCompletionsOptions	ChatCompletionsOptions.setFunctions(List<FunctionDefinition> functions)	Set the functions property: A list of functions the model may generate JSON inputs for.
ChatCompletionsOptions	ChatCompletionsOptions.setLogitBias(Map<String,Integer> logitBias)	Set the logitBias property: A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response.
ChatCompletionsOptions	ChatCompletionsOptions.setLogprobs(Boolean logprobs)	Set the logprobs property: Whether to return log probabilities of the output tokens or not.
ChatCompletionsOptions	ChatCompletionsOptions.setMaxCompletionTokens(Integer maxCompletionTokens)	Set the maxCompletionTokens property: An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
ChatCompletionsOptions	ChatCompletionsOptions.setMaxTokens(Integer maxTokens)	Set the maxTokens property: The maximum number of tokens allowed for the generated answer.
ChatCompletionsOptions	ChatCompletionsOptions.setModel(String model)	Set the model property: The model name to provide as part of this completions request.
ChatCompletionsOptions	ChatCompletionsOptions.setN(Integer n)	Set the n property: The number of chat completions choices that should be generated for a chat completions response.
ChatCompletionsOptions	ChatCompletionsOptions.setParallelToolCalls(Boolean parallelToolCalls)	Set the parallelToolCalls property: Whether to enable parallel function calling during tool use.
ChatCompletionsOptions	ChatCompletionsOptions.setPresencePenalty(Double presencePenalty)	Set the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
ChatCompletionsOptions	ChatCompletionsOptions.setResponseFormat(ChatCompletionsResponseFormat responseFormat)	Set the responseFormat property: An object specifying the format that the model must output.
ChatCompletionsOptions	ChatCompletionsOptions.setSeed(Long seed)	Set the seed property: If specified, the system will make a best effort to sample deterministically such that repeated requests with the same seed and parameters should return the same result.
ChatCompletionsOptions	ChatCompletionsOptions.setStop(List<String> stop)	Set the stop property: A collection of textual sequences that will end completions generation.
ChatCompletionsOptions	ChatCompletionsOptions.setTemperature(Double temperature)	Set the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
ChatCompletionsOptions	ChatCompletionsOptions.setToolChoice(ChatCompletionsToolSelection toolChoice)	Set the toolChoice property: If specified, the model will configure which of the provided tools it can use for the chat completions response.
ChatCompletionsOptions	ChatCompletionsOptions.setTools(List<ChatCompletionsToolDefinition> tools)	Set the tools property: The available tool definitions that the chat completions request can use, including caller-defined functions.
ChatCompletionsOptions	ChatCompletionsOptions.setTopLogprobs(Integer topLogprobs)	Set the topLogprobs property: An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability.
ChatCompletionsOptions	ChatCompletionsOptions.setTopP(Double topP)	Set the topP property: An alternative to sampling with temperature called nucleus sampling.
ChatCompletionsOptions	ChatCompletionsOptions.setUser(String user)	Set the user property: An identifier for the caller or end user of the operation.