Index (Azure SDK for Java Reference Documentation)

A B C E F G H I N O P R S T U V
All Classes and Interfaces|All Packages

A

addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
ASSISTANT - Static variable in class com.azure.ai.openai.models.ChatRole: The role that provides responses to system-instructed, user-prompted input.

B

buildAsyncClient() - Method in class com.azure.ai.openai.OpenAIClientBuilder: Builds an instance of OpenAIAsyncClient class.
buildClient() - Method in class com.azure.ai.openai.OpenAIClientBuilder: Builds an instance of OpenAIClient class.

C

ChatChoice - Class in com.azure.ai.openai.models: The representation of a single prompt completion as part of an overall chat completions request.
ChatCompletions - Class in com.azure.ai.openai.models: Representation of the response data from a chat completions request.
ChatCompletionsOptions - Class in com.azure.ai.openai.models: The configuration information for a chat completions request.
ChatCompletionsOptions(List<ChatMessage>) - Constructor for class com.azure.ai.openai.models.ChatCompletionsOptions: Creates an instance of ChatCompletionsOptions class.
ChatMessage - Class in com.azure.ai.openai.models: A single, role-attributed message within a chat completion interaction.
ChatMessage(ChatRole) - Constructor for class com.azure.ai.openai.models.ChatMessage: Creates an instance of ChatMessage class.
ChatRole - Class in com.azure.ai.openai.models: A description of the intended purpose of a message within a chat completions interaction.
ChatRole() - Constructor for class com.azure.ai.openai.models.ChatRole: Deprecated.
Use the fromString(String) factory method.
Choice - Class in com.azure.ai.openai.models: The representation of a single prompt completion as part of an overall completions request.
clientOptions(ClientOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
com.azure.ai.openai - package com.azure.ai.openai: Package containing the classes for OpenAI.
com.azure.ai.openai.models - package com.azure.ai.openai.models: Package containing the data models for OpenAI.
Completions - Class in com.azure.ai.openai.models: Representation of the response data from a completions request.
CompletionsFinishReason - Class in com.azure.ai.openai.models: Representation of the manner in which a completions response concluded.
CompletionsFinishReason() - Constructor for class com.azure.ai.openai.models.CompletionsFinishReason: Deprecated.
Use the CompletionsFinishReason.fromString(String) factory method.
CompletionsLogProbabilityModel - Class in com.azure.ai.openai.models: Representation of a log probabilities model for a completions generation.
CompletionsOptions - Class in com.azure.ai.openai.models: The configuration information for a completions request.
CompletionsOptions(List<String>) - Constructor for class com.azure.ai.openai.models.CompletionsOptions: Creates an instance of CompletionsOptions class.
CompletionsUsage - Class in com.azure.ai.openai.models: Representation of the token counts processed for a completions request.
configuration(Configuration) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
CONTENT_FILTERED - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completions generated a response that was identified as potentially sensitive per content moderation policies.
credential(NonAzureOpenAIKeyCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder: The NonAzureOpenAiKeyCredential used for public OpenAi authentication.
credential(AzureKeyCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
credential(TokenCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .

E

EmbeddingItem - Class in com.azure.ai.openai.models: Representation of a single embeddings relatedness comparison.
Embeddings - Class in com.azure.ai.openai.models: Representation of the response data from an embeddings request.
EmbeddingsOptions - Class in com.azure.ai.openai.models: The configuration information for an embeddings request.
EmbeddingsOptions(List<String>) - Constructor for class com.azure.ai.openai.models.EmbeddingsOptions: Creates an instance of EmbeddingsOptions class.
EmbeddingsUsage - Class in com.azure.ai.openai.models: Measurement of the amount of tokens used in this request and response.
endpoint(String) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .

F

fromString(String) - Static method in class com.azure.ai.openai.models.ChatRole: Creates or finds a ChatRole from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.CompletionsFinishReason: Creates or finds a CompletionsFinishReason from its string representation.

G

getBestOf() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the bestOf property: A value that controls how many completions will be internally generated prior to response formulation.
getChatCompletions(String, ChatCompletionsOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets chat completions for the provided chat messages.
getChatCompletions(String, ChatCompletionsOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets chat completions for the provided chat messages.
getChatCompletionsStream(String, ChatCompletionsOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets chat completions for the provided chat messages.
getChatCompletionsStream(String, ChatCompletionsOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets chat completions for the provided chat messages.
getChatCompletionsWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets chat completions for the provided chat messages.
getChatCompletionsWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets chat completions for the provided chat messages.
getChoices() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the choices property: The collection of completions choices associated with this completions response.
getChoices() - Method in class com.azure.ai.openai.models.Completions: Get the choices property: The collection of completions choices associated with this completions response.
getCompletions(String, CompletionsOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets completions for the provided input prompts.
getCompletions(String, CompletionsOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets completions for the provided input prompts.
getCompletions(String, String) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets completions for the provided input prompt.
getCompletions(String, String) - Method in class com.azure.ai.openai.OpenAIClient: Gets completions for the provided input prompt.
getCompletionsStream(String, CompletionsOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets completions as a stream for the provided input prompts.
getCompletionsStream(String, CompletionsOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets completions as a stream for the provided input prompts.
getCompletionsWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets completions for the provided input prompts.
getCompletionsWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets completions for the provided input prompts.
getCompletionTokens() - Method in class com.azure.ai.openai.models.CompletionsUsage: Get the completionTokens property: The number of tokens generated across all completions emissions.
getContent() - Method in class com.azure.ai.openai.models.ChatMessage: Get the content property: The text associated with this message payload.
getCreated() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the created property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
getCreated() - Method in class com.azure.ai.openai.models.Completions: Get the created property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
getData() - Method in class com.azure.ai.openai.models.Embeddings: Get the data property: Embedding values for the prompts submitted in the request.
getDelta() - Method in class com.azure.ai.openai.models.ChatChoice: Get the delta property: The delta message content for a streaming response.
getEmbedding() - Method in class com.azure.ai.openai.models.EmbeddingItem: Get the embedding property: List of embeddings value for the input prompt.
getEmbeddings(String, EmbeddingsOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Return the embeddings for a given prompt.
getEmbeddings(String, EmbeddingsOptions) - Method in class com.azure.ai.openai.OpenAIClient: Return the embeddings for a given prompt.
getEmbeddingsWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Return the embeddings for a given prompt.
getEmbeddingsWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Return the embeddings for a given prompt.
getFinishReason() - Method in class com.azure.ai.openai.models.ChatChoice: Get the finishReason property: The reason that this chat completions choice completed its generated.
getFinishReason() - Method in class com.azure.ai.openai.models.Choice: Get the finishReason property: Reason for finishing.
getFrequencyPenalty() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the frequencyPenalty property: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text.
getFrequencyPenalty() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the frequencyPenalty property: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text.
getId() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the id property: A unique identifier associated with this chat completions response.
getId() - Method in class com.azure.ai.openai.models.Completions: Get the id property: A unique identifier associated with this completions response.
getIndex() - Method in class com.azure.ai.openai.models.ChatChoice: Get the index property: The ordered index associated with this chat completions choice.
getIndex() - Method in class com.azure.ai.openai.models.Choice: Get the index property: The ordered index associated with this completions choice.
getIndex() - Method in class com.azure.ai.openai.models.EmbeddingItem: Get the index property: Index of the prompt to which the EmbeddingItem corresponds.
getInput() - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Get the input property: Input texts to get embeddings for, encoded as a an array of strings.
getKey() - Method in class com.azure.ai.openai.models.NonAzureOpenAIKeyCredential: Retrieves the key associated to this credential.
getLatest() - Static method in enum com.azure.ai.openai.OpenAIServiceVersion: Gets the latest service version supported by this client library.
getLogitBias() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the logitBias property: A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response.
getLogitBias() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the logitBias property: A map between GPT token IDs and bias scores that influences the probability of specific tokens appearing in a completions response.
getLogprobs() - Method in class com.azure.ai.openai.models.Choice: Get the logprobs property: The log probabilities model for tokens associated with this completions choice.
getLogprobs() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the logprobs property: A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response.
getMaxTokens() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the maxTokens property: The maximum number of tokens to generate.
getMaxTokens() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the maxTokens property: The maximum number of tokens to generate.
getMessage() - Method in class com.azure.ai.openai.models.ChatChoice: Get the message property: The chat message for a given chat completions prompt.
getMessages() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the messages property: The collection of context messages associated with this chat completions request.
getModel() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the model property: The model name to provide as part of this completions request.
getModel() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the model property: The model name to provide as part of this completions request.
getModel() - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Get the model property: The model name to provide as part of this embeddings request.
getN() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the n property: The number of chat completions choices that should be generated for a chat completions response.
getN() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the n property: The number of completions choices that should be generated per provided prompt as part of an overall completions response.
getPresencePenalty() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
getPresencePenalty() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
getPrompt() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the prompt property: The prompts to generate completions from.
getPromptTokens() - Method in class com.azure.ai.openai.models.CompletionsUsage: Get the promptTokens property: The number of tokens in the provided prompts for the completions request.
getPromptTokens() - Method in class com.azure.ai.openai.models.EmbeddingsUsage: Get the promptTokens property: Number of tokens sent in the original request.
getRole() - Method in class com.azure.ai.openai.models.ChatMessage: Get the role property: The role associated with this message payload.
getStop() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the stop property: A collection of textual sequences that will end completions generation.
getStop() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the stop property: A collection of textual sequences that will end completions generation.
getTemperature() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
getTemperature() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
getText() - Method in class com.azure.ai.openai.models.Choice: Get the text property: The generated text for a given completions prompt.
getTextOffset() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the textOffset property: The text offsets associated with tokens in this completions data.
getTokenLogprobs() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the tokenLogprobs property: A collection of log probability values for the tokens in this completions data.
getTokens() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the tokens property: The textual forms of tokens evaluated in this probability model.
getTopLogprobs() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the topLogprobs property: A mapping of tokens to maximum log probability values in this completions data.
getTopP() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the topP property: An alternative to sampling with temperature called nucleus sampling.
getTopP() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the topP property: An alternative to sampling with temperature called nucleus sampling.
getTotalTokens() - Method in class com.azure.ai.openai.models.CompletionsUsage: Get the totalTokens property: The total number of tokens processed for the completions request and response.
getTotalTokens() - Method in class com.azure.ai.openai.models.EmbeddingsUsage: Get the totalTokens property: Total number of tokens transacted in this request/response.
getUsage() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the usage property: Usage information for tokens processed and generated as part of this completions operation.
getUsage() - Method in class com.azure.ai.openai.models.Completions: Get the usage property: Usage information for tokens processed and generated as part of this completions operation.
getUsage() - Method in class com.azure.ai.openai.models.Embeddings: Get the usage property: Usage counts for tokens input using the embeddings API.
getUser() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the user property: An identifier for the caller or end user of the operation.
getUser() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the user property: An identifier for the caller or end user of the operation.
getUser() - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Get the user property: An identifier for the caller or end user of the operation.
getVersion() - Method in enum com.azure.ai.openai.OpenAIServiceVersion

H

httpClient(HttpClient) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .

I

isEcho() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the echo property: A value specifying whether completions responses should include input prompts as prefixes to their generated output.
isStream() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the stream property: A value indicating whether chat completions should be streamed for this request.
isStream() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the stream property: A value indicating whether chat completions should be streamed for this request.

N

NonAzureOpenAIKeyCredential - Class in com.azure.ai.openai.models: Non-Azure OpenAI API keys credential class for accepting non-Azure OpenAI API key credential string.
NonAzureOpenAIKeyCredential(String) - Constructor for class com.azure.ai.openai.models.NonAzureOpenAIKeyCredential: Create a non-Azure OpenAI API key credential.

O

OpenAIAsyncClient - Class in com.azure.ai.openai: Initializes a new instance of the asynchronous OpenAIClient type.
OpenAIClient - Class in com.azure.ai.openai: Initializes a new instance of the synchronous OpenAIClient type.
OpenAIClientBuilder - Class in com.azure.ai.openai: A builder for creating a new instance of the OpenAIClient type.
OpenAIClientBuilder() - Constructor for class com.azure.ai.openai.OpenAIClientBuilder: Create an instance of the OpenAIClientBuilder.
OpenAIServiceVersion - Enum in com.azure.ai.openai: Service version of OpenAIClient.

P

pipeline(HttpPipeline) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .

R

retryOptions(RetryOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
retryPolicy(RetryPolicy) - Method in class com.azure.ai.openai.OpenAIClientBuilder: Sets The retry policy that will attempt to retry failed requests, if applicable.

S

serviceVersion(OpenAIServiceVersion) - Method in class com.azure.ai.openai.OpenAIClientBuilder: Sets Service version.
setBestOf(Integer) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the bestOf property: A value that controls how many completions will be internally generated prior to response formulation.
setContent(String) - Method in class com.azure.ai.openai.models.ChatMessage: Set the content property: The text associated with this message payload.
setEcho(Boolean) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the echo property: A value specifying whether completions responses should include input prompts as prefixes to their generated output.
setFrequencyPenalty(Double) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the frequencyPenalty property: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text.
setFrequencyPenalty(Double) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the frequencyPenalty property: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text.
setLogitBias(Map<String, Integer>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: 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.
setLogitBias(Map<String, Integer>) - Method in class com.azure.ai.openai.models.CompletionsOptions: 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.
setLogprobs(Integer) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the logprobs property: A value that controls the emission of log probabilities for the provided number of most likely tokens within a completions response.
setMaxTokens(Integer) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the maxTokens property: The maximum number of tokens to generate.
setMaxTokens(Integer) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the maxTokens property: The maximum number of tokens to generate.
setModel(String) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the model property: The model name to provide as part of this completions request.
setModel(String) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the model property: The model name to provide as part of this completions request.
setModel(String) - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Set the model property: The model name to provide as part of this embeddings request.
setN(Integer) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the n property: The number of chat completions choices that should be generated for a chat completions response.
setN(Integer) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the n property: The number of completions choices that should be generated per provided prompt as part of an overall completions response.
setPresencePenalty(Double) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
setPresencePenalty(Double) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
setStop(List<String>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the stop property: A collection of textual sequences that will end completions generation.
setStop(List<String>) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the stop property: A collection of textual sequences that will end completions generation.
setStream(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the stream property: A value indicating whether chat completions should be streamed for this request.
setStream(Boolean) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the stream property: A value indicating whether chat completions should be streamed for this request.
setTemperature(Double) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
setTemperature(Double) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
setTopP(Double) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the topP property: An alternative to sampling with temperature called nucleus sampling.
setTopP(Double) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the topP property: An alternative to sampling with temperature called nucleus sampling.
setUser(String) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the user property: An identifier for the caller or end user of the operation.
setUser(String) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the user property: An identifier for the caller or end user of the operation.
setUser(String) - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Set the user property: An identifier for the caller or end user of the operation.
STOPPED - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completions ended normally and reached its end of token generation.
SYSTEM - Static variable in class com.azure.ai.openai.models.ChatRole: The role that instructs or sets the behavior of the assistant.

T

TOKEN_LIMIT_REACHED - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completions exhausted available token limits before generation could complete.

U

update(String) - Method in class com.azure.ai.openai.models.NonAzureOpenAIKeyCredential: Update the OpenAI API key value.
USER - Static variable in class com.azure.ai.openai.models.ChatRole: The role that provides input for chat completions.

V

V2022_12_01 - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2022-12-01.
V2023_03_15_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2023-03-15-preview.
valueOf(String) - Static method in enum com.azure.ai.openai.OpenAIServiceVersion: Returns the enum constant of this type with the specified name.
values() - Static method in class com.azure.ai.openai.models.ChatRole: Gets known ChatRole values.
values() - Static method in class com.azure.ai.openai.models.CompletionsFinishReason: Gets known CompletionsFinishReason values.
values() - Static method in enum com.azure.ai.openai.OpenAIServiceVersion: Returns an array containing the constants of this enum type, in the order they are declared.

A B C E F G H I N O P R S T U V
All Classes and Interfaces|All Packages