Index (Azure SDK for Java Reference Documentation)

A B C D E F G H I L M 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.
AUTO - Static variable in class com.azure.ai.openai.models.FunctionCallConfig: AUTO will indicate the service to call any functions that are necessary for text completion generation.
AzureOpenAIOperationState - Class in com.azure.ai.openai.models: The state of a job or item.
AzureOpenAIOperationState() - Constructor for class com.azure.ai.openai.models.AzureOpenAIOperationState: Deprecated.
Use the AzureOpenAIOperationState.fromString(String) factory method.

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

CANCELED - Static variable in class com.azure.ai.openai.models.AzureOpenAIOperationState: The operation has been canceled and is incomplete.
CANCELED - Static variable in class com.azure.ai.openai.models.State: The operation has been canceled and is incomplete.
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, String) - 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 ChatRole.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.
ContentFilterResult - Class in com.azure.ai.openai.models: Information about filtered content severity level and if it has been filtered or not.
ContentFilterResults - Class in com.azure.ai.openai.models: Information about the content filtering category, if it has been detected.
ContentFilterSeverity - Class in com.azure.ai.openai.models: Ratings for the intensity and risk level of harmful content.
ContentFilterSeverity() - Constructor for class com.azure.ai.openai.models.ContentFilterSeverity: Deprecated.
Use the ContentFilterSeverity.fromString(String) factory method.
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: .

D

DELETED - Static variable in class com.azure.ai.openai.models.AzureOpenAIOperationState: The entity has been deleted but may still be referenced by other entities that originated before the deletion.
DELETED - Static variable in class com.azure.ai.openai.models.State: The entity has been deleted but may still be referenced by other entities predating the deletion.

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

FAILED - Static variable in class com.azure.ai.openai.models.AzureOpenAIOperationState: The operation has completed processing with a failure and cannot be further consumed.
FAILED - Static variable in class com.azure.ai.openai.models.State: The operation has completed processing with a failure and cannot be further consumed.
fromString(String) - Static method in class com.azure.ai.openai.models.AzureOpenAIOperationState: Creates or finds a AzureOpenAIOperationState from its string representation.
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.
fromString(String) - Static method in class com.azure.ai.openai.models.ContentFilterSeverity: Creates or finds a ContentFilterSeverity from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.ImageSize: Creates or finds a ImageSize from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.State: Creates or finds a State from its string representation.
FUNCTION - Static variable in class com.azure.ai.openai.models.ChatRole: The role that provides function results for char completions.
FUNCTION_CALL - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completion ended normally, with the model requesting a function to be called.
FunctionCall - Class in com.azure.ai.openai.models: The name and arguments of a function that should be called, as generated by the model.
FunctionCall(String, String) - Constructor for class com.azure.ai.openai.models.FunctionCall: Creates an instance of FunctionCall class.
FunctionCallConfig - Class in com.azure.ai.openai.models: The name and arguments of a function that should be called, as generated by the model.
FunctionCallConfig(String) - Constructor for class com.azure.ai.openai.models.FunctionCallConfig: Creates an instance of FunctionCallConfig class.
FunctionDefinition - Class in com.azure.ai.openai.models: The definition of a caller-specified function that chat completions may invoke in response to matching user input.
FunctionDefinition(String) - Constructor for class com.azure.ai.openai.models.FunctionDefinition: Creates an instance of FunctionDefinition class.
FunctionName - Class in com.azure.ai.openai.models: A structure that specifies the exact name of a specific, request-provided function to use when processing a chat completions operation.
FunctionName(String) - Constructor for class com.azure.ai.openai.models.FunctionName: Creates an instance of FunctionName class.

G

getArguments() - Method in class com.azure.ai.openai.models.FunctionCall: Get the arguments property: The arguments to call the function with, as generated by the model in JSON format.
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.
getContentFilterResults() - Method in class com.azure.ai.openai.models.ChatChoice: Get the contentFilterResults property: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not.
getContentFilterResults() - Method in class com.azure.ai.openai.models.Choice: Get the contentFilterResults property: Information about the content filtering category (hate, sexual, violence, self_harm), if it has been detected, as well as the severity level (very_low, low, medium, high-scale that determines the intensity and risk level of harmful content) and if it has been filtered or not.
getContentFilterResults() - Method in class com.azure.ai.openai.models.PromptFilterResult: Get the contentFilterResults property: Content filtering results for this prompt.
getCreated() - Method in class com.azure.ai.openai.models.ImageOperationResponse: Get the created property: A timestamp when this job or item was created (in unix epochs).
getCreated() - Method in class com.azure.ai.openai.models.ImageResponse: Get the created property: A timestamp when this job or item was created (in unix epochs).
getCreatedAt() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the createdAt 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.
getCreatedAt() - Method in class com.azure.ai.openai.models.Completions: Get the createdAt 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.
getData() - Method in class com.azure.ai.openai.models.ImageResponse: Get the data property: The images generated by the operator.
getDelta() - Method in class com.azure.ai.openai.models.ChatChoice: Get the delta property: The delta message content for a streaming response.
getDescription() - Method in class com.azure.ai.openai.models.FunctionDefinition: Get the description property: A description of what the function does.
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.
getError() - Method in class com.azure.ai.openai.models.ImageLocation: Get the error property: The error if the operation failed.
getError() - Method in class com.azure.ai.openai.models.ImageOperationResponse: Get the error property: The error if the operation failed.
getExpires() - Method in class com.azure.ai.openai.models.ImageOperationResponse: Get the expires property: A timestamp when this operation and its associated images expire and will be deleted (in unix epochs).
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.
getFunctionCall() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the functionCall property: Controls how the model responds to function calls.
getFunctionCall() - Method in class com.azure.ai.openai.models.ChatMessage: Get the functionCall property: The name and arguments of a function that should be called, as generated by the model.
getFunctions() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the functions property: A list of functions the model may generate JSON inputs for.
getHate() - Method in class com.azure.ai.openai.models.ContentFilterResults: Get the hate property: Describes language attacks or uses that include pejorative or discriminatory language with reference to a person or identity group on the basis of certain differentiating attributes of these groups including but not limited to race, ethnicity, nationality, gender identity and expression, sexual orientation, religion, immigration status, ability status, personal appearance, and body size.
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.
getId() - Method in class com.azure.ai.openai.models.ImageOperationResponse: Get the id property: The ID of the operation.
getId() - Method in class com.azure.ai.openai.models.ImageOperationStatus: Get the id property: The unique ID of the operation.
getImages(ImageGenerationOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Starts the generation of a batch of images from a text caption.
getImages(ImageGenerationOptions) - Method in class com.azure.ai.openai.OpenAIClient: Starts the generation of a batch of images from a text caption.
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.
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.
getN() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the n property: The number of images to generate (defaults to 1).
getName() - Method in class com.azure.ai.openai.models.ChatMessage: Get the name property: The name of the author of this message.
getName() - Method in class com.azure.ai.openai.models.FunctionCall: Get the name property: The name of the function to call.
getName() - Method in class com.azure.ai.openai.models.FunctionCallConfig: Get the name property: The name of the function to call.
getName() - Method in class com.azure.ai.openai.models.FunctionDefinition: Get the name property: The name of the function to be called.
getName() - Method in class com.azure.ai.openai.models.FunctionName: Get the name property: The name of the function to call.
getParameters() - Method in class com.azure.ai.openai.models.FunctionDefinition: Get the parameters property: The parameters the functions accepts, described as a JSON Schema object.
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.
getPrompt() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the prompt property: A description of the desired images.
getPromptFilterResults() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the promptFilterResults property: Content filtering results for zero or more prompts in the request.
getPromptFilterResults() - Method in class com.azure.ai.openai.models.Completions: Get the promptFilterResults property: Content filtering results for zero or more prompts in the request.
getPromptIndex() - Method in class com.azure.ai.openai.models.EmbeddingItem: Get the promptIndex property: Index of the prompt to which the EmbeddingItem corresponds.
getPromptIndex() - Method in class com.azure.ai.openai.models.PromptFilterResult: Get the promptIndex property: The index of this prompt in the set of prompt results.
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.
getResult() - Method in class com.azure.ai.openai.models.ImageOperationResponse: Get the result property: The result of the operation if the operation succeeded.
getRole() - Method in class com.azure.ai.openai.models.ChatMessage: Get the role property: The role associated with this message payload.
getSelfHarm() - Method in class com.azure.ai.openai.models.ContentFilterResults: Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
getSeverity() - Method in class com.azure.ai.openai.models.ContentFilterResult: Get the severity property: Ratings for the intensity and risk level of filtered content.
getSexual() - Method in class com.azure.ai.openai.models.ContentFilterResults: Get the sexual property: Describes language related to anatomical organs and genitals, romantic relationships, acts portrayed in erotic or affectionate terms, physical sexual acts, including those portrayed as an assault or a forced sexual violent act against one’s will, prostitution, pornography, and abuse.
getSize() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the size property: The desired size of the generated images.
getStatus() - Method in class com.azure.ai.openai.models.ImageOperationResponse: Get the status property: The status of the operation.
getStatus() - Method in class com.azure.ai.openai.models.ImageOperationStatus: Get the status property: The status of the operation.
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.
getTextOffsets() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the textOffsets property: The text offsets associated with tokens in this completions data.
getTokenLogProbabilities() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the tokenLogProbabilities 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.
getTopLogProbabilities() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the topLogProbabilities 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.
getUrl() - Method in class com.azure.ai.openai.models.ImageLocation: Get the url property: The URL that provides temporary access to download the generated image.
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.
getUser() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the user property: A unique identifier representing your end-user, which can help to monitor and detect abuse.
getVersion() - Method in enum com.azure.ai.openai.OpenAIServiceVersion
getViolence() - Method in class com.azure.ai.openai.models.ContentFilterResults: Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.

H

HIGH - Static variable in class com.azure.ai.openai.models.ContentFilterSeverity: Content that displays explicit and severe harmful instructions, actions, damage, or abuse; includes endorsement, glorification, or promotion of severe harmful acts, extreme or illegal forms of harm, radicalization, or non-consensual power exchange or abuse.
httpClient(HttpClient) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .

I

ImageGenerationOptions - Class in com.azure.ai.openai.models: Represents the request data used to generate images.
ImageGenerationOptions(String) - Constructor for class com.azure.ai.openai.models.ImageGenerationOptions: Creates an instance of ImageGenerationOptions class.
ImageLocation - Class in com.azure.ai.openai.models: The image url if successful, and an error otherwise.
ImageOperationResponse - Class in com.azure.ai.openai.models: A polling status update or final response payload for an image operation.
ImageOperationStatus - Class in com.azure.ai.openai.models: Provides status details for long running operations.
ImageResponse - Class in com.azure.ai.openai.models: The result of the operation if the operation succeeded.
ImageSize - Class in com.azure.ai.openai.models: The desired size of the generated images.
ImageSize() - Constructor for class com.azure.ai.openai.models.ImageSize: Deprecated.
Use the ImageSize.fromString(String) factory method.
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.
isFiltered() - Method in class com.azure.ai.openai.models.ContentFilterResult: Get the filtered property: A value indicating whether or not the content has been filtered.
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.

L

LOW - Static variable in class com.azure.ai.openai.models.ContentFilterSeverity: Content that expresses prejudiced, judgmental, or opinionated views, includes offensive use of language, stereotyping, use cases exploring a fictional world (for example, gaming, literature) and depictions at low intensity.

M

MEDIUM - Static variable in class com.azure.ai.openai.models.ContentFilterSeverity: Content that uses offensive, insulting, mocking, intimidating, or demeaning language towards specific identity groups, includes depictions of seeking and executing harmful instructions, fantasies, glorification, promotion of harm at medium intensity.

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.
NONE - Static variable in class com.azure.ai.openai.models.FunctionCallConfig: NONE will indicate the service to not call nay of the functions that may have been provided with the request for text completion generation.
NOT_RUNNING - Static variable in class com.azure.ai.openai.models.AzureOpenAIOperationState: The operation was created and is queued to be processed in the future.
NOT_RUNNING - Static variable in class com.azure.ai.openai.models.State: The operation was created and is queued to be processed in the future.

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: .
PromptFilterResult - Class in com.azure.ai.openai.models: Content filtering results for a single prompt in the request.

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.
RUNNING - Static variable in class com.azure.ai.openai.models.AzureOpenAIOperationState: The operation has started to be processed.
RUNNING - Static variable in class com.azure.ai.openai.models.State: The operation has started to be processed.

S

SAFE - Static variable in class com.azure.ai.openai.models.ContentFilterSeverity: Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences.
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.
setDescription(String) - Method in class com.azure.ai.openai.models.FunctionDefinition: Set the description property: A description of what the function does.
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.
setFunctionCall(FunctionCall) - Method in class com.azure.ai.openai.models.ChatMessage: Set the functionCall property: The name and arguments of a function that should be called, as generated by the model.
setFunctionCall(FunctionCallConfig) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the functionCall property: Controls how the model responds to function calls.
setFunctions(List<FunctionDefinition>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the functions property: A list of functions the model may generate JSON inputs for.
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.
setN(Integer) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the n property: The number of images to generate (defaults to 1).
setName(String) - Method in class com.azure.ai.openai.models.ChatMessage: Set the name property: The name of the author of this message.
setParameters(Object) - Method in class com.azure.ai.openai.models.FunctionDefinition: Set the parameters property: The parameters the functions accepts, described as a JSON Schema object.
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.
setSize(ImageSize) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the size property: The desired size of the generated images.
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.
setUser(String) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the user property: A unique identifier representing your end-user, which can help to monitor and detect abuse.
SIZE1024X1024 - Static variable in class com.azure.ai.openai.models.ImageSize: Image size of 1024x1024.
SIZE256X256 - Static variable in class com.azure.ai.openai.models.ImageSize: Image size of 256x256.
SIZE512X512 - Static variable in class com.azure.ai.openai.models.ImageSize: Image size of 512x512.
State - Class in com.azure.ai.openai.models: The state of a job or item.
State() - Constructor for class com.azure.ai.openai.models.State: Deprecated.
Use the State.fromString(String) factory method.
STOPPED - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completions ended normally and reached its end of token generation.
SUCCEEDED - Static variable in class com.azure.ai.openai.models.AzureOpenAIOperationState: The operation has successfully be processed and is ready for consumption.
SUCCEEDED - Static variable in class com.azure.ai.openai.models.State: The operation has successfully be processed and is ready for consumption.
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_05_15 - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2023-05-15.
V2023_06_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2023-06-01-preview.
V2023_07_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2023-07-01-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.AzureOpenAIOperationState: Gets known AzureOpenAIOperationState values.
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 class com.azure.ai.openai.models.ContentFilterSeverity: Gets known ContentFilterSeverity values.
values() - Static method in class com.azure.ai.openai.models.ImageSize: Gets known ImageSize values.
values() - Static method in class com.azure.ai.openai.models.State: Gets known State 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 D E F G H I L M N O P R S T U V
All Classes and Interfaces|All Packages