Index (Azure SDK for Java Reference Documentation)

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

A

AAC - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat: Use AAC as the audio output format.
addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
ALLOY - Static variable in class com.azure.ai.openai.models.SpeechVoice: The Alloy voice.
ASSISTANT - Static variable in class com.azure.ai.openai.models.ChatRole: The role that provides responses to system-instructed, user-prompted input.
AudioTaskLabel - Class in com.azure.ai.openai.models: Defines the possible descriptors for available audio operation responses.
AudioTaskLabel() - Constructor for class com.azure.ai.openai.models.AudioTaskLabel: Deprecated.
Use the AudioTaskLabel.fromString(String) factory method.
AudioTranscription - Class in com.azure.ai.openai.models: Result information for an operation that transcribed spoken audio into written text.
AudioTranscriptionFormat - Class in com.azure.ai.openai.models: Defines available options for the underlying response format of output transcription information.
AudioTranscriptionFormat() - Constructor for class com.azure.ai.openai.models.AudioTranscriptionFormat: Deprecated.
Use the AudioTranscriptionFormat.fromString(String) factory method.
AudioTranscriptionOptions - Class in com.azure.ai.openai.models: The configuration information for an audio transcription request.
AudioTranscriptionOptions(byte[]) - Constructor for class com.azure.ai.openai.models.AudioTranscriptionOptions: Creates an instance of AudioTranscriptionOptions class.
AudioTranscriptionSegment - Class in com.azure.ai.openai.models: Extended information about a single segment of transcribed audio data.
AudioTranslation - Class in com.azure.ai.openai.models: Result information for an operation that translated spoken audio into written text.
AudioTranslationFormat - Class in com.azure.ai.openai.models: Defines available options for the underlying response format of output translation information.
AudioTranslationFormat() - Constructor for class com.azure.ai.openai.models.AudioTranslationFormat: Deprecated.
Use the AudioTranslationFormat.fromString(String) factory method.
AudioTranslationOptions - Class in com.azure.ai.openai.models: The configuration information for an audio translation request.
AudioTranslationOptions(byte[]) - Constructor for class com.azure.ai.openai.models.AudioTranslationOptions: Creates an instance of AudioTranslationOptions class.
AudioTranslationSegment - Class in com.azure.ai.openai.models: Extended information about a single segment of translated audio data.
AUTO - Static variable in class com.azure.ai.openai.models.ChatCompletionsToolSelectionPreset: Specifies that the model may either use any of the tools provided in this chat completions request or instead return a standard chat completions response as if no tools were provided.
AUTO - Static variable in class com.azure.ai.openai.models.ChatMessageImageDetailLevel: Specifies that the model should determine which detail level to apply using heuristics like image size.
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.
AzureChatEnhancementConfiguration - Class in com.azure.ai.openai.models: A representation of the available Azure OpenAI enhancement configurations.
AzureChatEnhancementConfiguration() - Constructor for class com.azure.ai.openai.models.AzureChatEnhancementConfiguration: Creates an instance of AzureChatEnhancementConfiguration class.
AzureChatEnhancements - Class in com.azure.ai.openai.models: Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided in the request.
AzureChatExtensionConfiguration - Class in com.azure.ai.openai.models: A representation of configuration data for a single Azure OpenAI chat extension.
AzureChatExtensionConfiguration() - Constructor for class com.azure.ai.openai.models.AzureChatExtensionConfiguration: Creates an instance of AzureChatExtensionConfiguration class.
AzureChatExtensionDataSourceResponseCitation - Class in com.azure.ai.openai.models: A single instance of additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response.
AzureChatExtensionsMessageContext - Class in com.azure.ai.openai.models: A representation of the additional context information available when Azure OpenAI chat extensions are involved in the generation of a corresponding chat completions response.
AzureChatGroundingEnhancementConfiguration - Class in com.azure.ai.openai.models: A representation of the available options for the Azure OpenAI grounding enhancement.
AzureChatGroundingEnhancementConfiguration(boolean) - Constructor for class com.azure.ai.openai.models.AzureChatGroundingEnhancementConfiguration: Creates an instance of AzureChatGroundingEnhancementConfiguration class.
AzureChatOCREnhancementConfiguration - Class in com.azure.ai.openai.models: A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.
AzureChatOCREnhancementConfiguration(boolean) - Constructor for class com.azure.ai.openai.models.AzureChatOCREnhancementConfiguration: Creates an instance of AzureChatOCREnhancementConfiguration class.
AzureCosmosDBChatExtensionConfiguration - Class in com.azure.ai.openai.models: A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat extension.
AzureCosmosDBChatExtensionConfiguration(AzureCosmosDBChatExtensionParameters) - Constructor for class com.azure.ai.openai.models.AzureCosmosDBChatExtensionConfiguration: Creates an instance of AzureCosmosDBChatExtensionConfiguration class.
AzureCosmosDBChatExtensionParameters - Class in com.azure.ai.openai.models: Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for MongoDB vCore.
AzureCosmosDBChatExtensionParameters(String, String, String, AzureCosmosDBFieldMappingOptions, OnYourDataVectorizationSource) - Constructor for class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Creates an instance of AzureCosmosDBChatExtensionParameters class.
AzureCosmosDBFieldMappingOptions - Class in com.azure.ai.openai.models: Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.
AzureCosmosDBFieldMappingOptions(List<String>, List<String>) - Constructor for class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Creates an instance of AzureCosmosDBFieldMappingOptions class.
AzureGroundingEnhancement - Class in com.azure.ai.openai.models: The grounding enhancement that returns the bounding box of the objects detected in the image.
AzureGroundingEnhancementCoordinatePoint - Class in com.azure.ai.openai.models: A representation of a single polygon point as used by the Azure grounding enhancement.
AzureGroundingEnhancementLine - Class in com.azure.ai.openai.models: A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
AzureGroundingEnhancementLineSpan - Class in com.azure.ai.openai.models: A span object that represents a detected object and its bounding box information.
AzureMachineLearningIndexChatExtensionConfiguration - Class in com.azure.ai.openai.models: A specific representation of configurable options for Azure Machine Learning vector index when using it as an Azure OpenAI chat extension.
AzureMachineLearningIndexChatExtensionConfiguration(AzureMachineLearningIndexChatExtensionParameters) - Constructor for class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionConfiguration: Creates an instance of AzureMachineLearningIndexChatExtensionConfiguration class.
AzureMachineLearningIndexChatExtensionParameters - Class in com.azure.ai.openai.models: Parameters for the Azure Machine Learning vector index chat extension.
AzureMachineLearningIndexChatExtensionParameters(String, String, String) - Constructor for class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Creates an instance of AzureMachineLearningIndexChatExtensionParameters class.
AzureSearchChatExtensionConfiguration - Class in com.azure.ai.openai.models: A specific representation of configurable options for Azure Search when using it as an Azure OpenAI chat extension.
AzureSearchChatExtensionConfiguration(AzureSearchChatExtensionParameters) - Constructor for class com.azure.ai.openai.models.AzureSearchChatExtensionConfiguration: Creates an instance of AzureSearchChatExtensionConfiguration class.
AzureSearchChatExtensionParameters - Class in com.azure.ai.openai.models: Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension.
AzureSearchChatExtensionParameters(String, String) - Constructor for class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Creates an instance of AzureSearchChatExtensionParameters class.
AzureSearchIndexFieldMappingOptions - Class in com.azure.ai.openai.models: Optional settings to control how fields are processed when using a configured Azure Search resource.
AzureSearchIndexFieldMappingOptions() - Constructor for class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Creates an instance of AzureSearchIndexFieldMappingOptions class.
AzureSearchQueryType - Class in com.azure.ai.openai.models: The type of Azure Search retrieval query that should be executed when using it as an Azure OpenAI chat extension.
AzureSearchQueryType() - Constructor for class com.azure.ai.openai.models.AzureSearchQueryType: Deprecated.
Use the AzureSearchQueryType.fromString(String) factory method.

B

BASE64 - Static variable in class com.azure.ai.openai.models.ImageGenerationResponseFormat: Image generation response items should provide image data as a base64-encoded string.
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.
ChatChoiceLogProbabilityInfo - Class in com.azure.ai.openai.models: Log probability information for a choice, as requested via 'logprobs' and 'top_logprobs'.
ChatCompletions - Class in com.azure.ai.openai.models: Representation of the response data from a chat completions request.
ChatCompletionsFunctionToolCall - Class in com.azure.ai.openai.models: A tool call to a function tool, issued by the model in evaluation of a configured function tool, that represents a function invocation needed for a subsequent chat completions request to resolve.
ChatCompletionsFunctionToolCall(String, FunctionCall) - Constructor for class com.azure.ai.openai.models.ChatCompletionsFunctionToolCall: Creates an instance of ChatCompletionsFunctionToolCall class.
ChatCompletionsFunctionToolDefinition - Class in com.azure.ai.openai.models: The definition information for a chat completions function tool that can call a function in response to a tool call.
ChatCompletionsFunctionToolDefinition(FunctionDefinition) - Constructor for class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition: Creates an instance of ChatCompletionsFunctionToolDefinition class.
ChatCompletionsFunctionToolSelection - Class in com.azure.ai.openai.models: A tool selection of a specific, named function tool that will limit chat completions to using the named function.
ChatCompletionsFunctionToolSelection(String) - Constructor for class com.azure.ai.openai.models.ChatCompletionsFunctionToolSelection: Creates an instance of ChatCompletionsFunctionToolSelection class.
ChatCompletionsJsonResponseFormat - Class in com.azure.ai.openai.models: A response format for Chat Completions that restricts responses to emitting valid JSON objects.
ChatCompletionsJsonResponseFormat() - Constructor for class com.azure.ai.openai.models.ChatCompletionsJsonResponseFormat: Creates an instance of ChatCompletionsJsonResponseFormat class.
ChatCompletionsNamedFunctionToolSelection - Class in com.azure.ai.openai.models: A tool selection of a specific, named function tool that will limit chat completions to using the named function.
ChatCompletionsNamedFunctionToolSelection(ChatCompletionsFunctionToolSelection) - Constructor for class com.azure.ai.openai.models.ChatCompletionsNamedFunctionToolSelection: Creates an instance of ChatCompletionsNamedFunctionToolSelection class.
ChatCompletionsNamedToolSelection - Class in com.azure.ai.openai.models: An abstract representation of an explicit, named tool selection to use for a chat completions request.
ChatCompletionsNamedToolSelection() - Constructor for class com.azure.ai.openai.models.ChatCompletionsNamedToolSelection: Creates an instance of ChatCompletionsNamedToolSelection class.
ChatCompletionsOptions - Class in com.azure.ai.openai.models: The configuration information for a chat completions request.
ChatCompletionsOptions(List<ChatRequestMessage>) - Constructor for class com.azure.ai.openai.models.ChatCompletionsOptions: Creates an instance of ChatCompletionsOptions class.
ChatCompletionsResponseFormat - Class in com.azure.ai.openai.models: An abstract representation of a response format configuration usable by Chat Completions.
ChatCompletionsResponseFormat() - Constructor for class com.azure.ai.openai.models.ChatCompletionsResponseFormat: Creates an instance of ChatCompletionsResponseFormat class.
ChatCompletionsTextResponseFormat - Class in com.azure.ai.openai.models: The standard Chat Completions response format that can freely generate text and is not guaranteed to produce response content that adheres to a specific schema.
ChatCompletionsTextResponseFormat() - Constructor for class com.azure.ai.openai.models.ChatCompletionsTextResponseFormat: Creates an instance of ChatCompletionsTextResponseFormat class.
ChatCompletionsToolCall - Class in com.azure.ai.openai.models: An abstract representation of a tool call that must be resolved in a subsequent request to perform the requested chat completion.
ChatCompletionsToolCall(String, String) - Constructor for class com.azure.ai.openai.models.ChatCompletionsToolCall: Creates an instance of ChatCompletionsToolCall class.
ChatCompletionsToolDefinition - Class in com.azure.ai.openai.models: An abstract representation of a tool that can be used by the model to improve a chat completions response.
ChatCompletionsToolDefinition() - Constructor for class com.azure.ai.openai.models.ChatCompletionsToolDefinition: Creates an instance of ChatCompletionsToolDefinition class.
ChatCompletionsToolSelectionPreset - Class in com.azure.ai.openai.models: Represents a generic policy for how a chat completions tool may be selected.
ChatCompletionsToolSelectionPreset() - Constructor for class com.azure.ai.openai.models.ChatCompletionsToolSelectionPreset: Deprecated.
Use the ChatCompletionsToolSelectionPreset.fromString(String) factory method.
ChatFinishDetails - Class in com.azure.ai.openai.models: An abstract representation of structured information about why a chat completions response terminated.
ChatFinishDetails() - Constructor for class com.azure.ai.openai.models.ChatFinishDetails: Creates an instance of ChatFinishDetails class.
ChatMessageContentItem - Class in com.azure.ai.openai.models: An abstract representation of a structured content item within a chat message.
ChatMessageContentItem() - Constructor for class com.azure.ai.openai.models.ChatMessageContentItem: Creates an instance of ChatMessageContentItem class.
ChatMessageImageContentItem - Class in com.azure.ai.openai.models: A structured chat content item containing an image reference.
ChatMessageImageContentItem(ChatMessageImageUrl) - Constructor for class com.azure.ai.openai.models.ChatMessageImageContentItem: Creates an instance of ChatMessageImageContentItem class.
ChatMessageImageDetailLevel - Class in com.azure.ai.openai.models: A representation of the possible image detail levels for image-based chat completions message content.
ChatMessageImageDetailLevel() - Constructor for class com.azure.ai.openai.models.ChatMessageImageDetailLevel: Deprecated.
Use the ChatMessageImageDetailLevel.fromString(String) factory method.
ChatMessageImageUrl - Class in com.azure.ai.openai.models: An internet location from which the model may retrieve an image.
ChatMessageImageUrl(String) - Constructor for class com.azure.ai.openai.models.ChatMessageImageUrl: Creates an instance of ChatMessageImageUrl class.
ChatMessageTextContentItem - Class in com.azure.ai.openai.models: A structured chat content item containing plain text.
ChatMessageTextContentItem(String) - Constructor for class com.azure.ai.openai.models.ChatMessageTextContentItem: Creates an instance of ChatMessageTextContentItem class.
ChatRequestAssistantMessage - Class in com.azure.ai.openai.models: A request chat message representing response or action from the assistant.
ChatRequestAssistantMessage(String) - Constructor for class com.azure.ai.openai.models.ChatRequestAssistantMessage: Creates an instance of ChatRequestAssistantMessage class.
ChatRequestFunctionMessage - Class in com.azure.ai.openai.models: A request chat message representing requested output from a configured function.
ChatRequestFunctionMessage(String, String) - Constructor for class com.azure.ai.openai.models.ChatRequestFunctionMessage: Creates an instance of ChatRequestFunctionMessage class.
ChatRequestMessage - Class in com.azure.ai.openai.models: An abstract representation of a chat message as provided in a request.
ChatRequestMessage() - Constructor for class com.azure.ai.openai.models.ChatRequestMessage: Creates an instance of ChatRequestMessage class.
ChatRequestSystemMessage - Class in com.azure.ai.openai.models: A request chat message containing system instructions that influence how the model will generate a chat completions response.
ChatRequestSystemMessage(String) - Constructor for class com.azure.ai.openai.models.ChatRequestSystemMessage: Creates an instance of ChatRequestSystemMessage class.
ChatRequestToolMessage - Class in com.azure.ai.openai.models: A request chat message representing requested output from a configured tool.
ChatRequestToolMessage(String, String) - Constructor for class com.azure.ai.openai.models.ChatRequestToolMessage: Creates an instance of ChatRequestToolMessage class.
ChatRequestUserMessage - Class in com.azure.ai.openai.models: A request chat message representing user input to the assistant.
ChatRequestUserMessage(ChatMessageContentItem[]) - Constructor for class com.azure.ai.openai.models.ChatRequestUserMessage: Creates a new instance of ChatRequestUserMessage using a collection of structured content.
ChatRequestUserMessage(String) - Constructor for class com.azure.ai.openai.models.ChatRequestUserMessage: Creates a new instance of ChatRequestUserMessage using plain text content.
ChatRequestUserMessage(List<ChatMessageContentItem>) - Constructor for class com.azure.ai.openai.models.ChatRequestUserMessage: Creates a new instance of ChatRequestUserMessage using a collection of structured content.
ChatResponseMessage - Class in com.azure.ai.openai.models: A representation of a chat message as received in a response.
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.
ChatTokenLogProbabilityInfo - Class in com.azure.ai.openai.models: A representation of the log probability information for a single message content token.
ChatTokenLogProbabilityResult - Class in com.azure.ai.openai.models: A representation of the log probability information for a single content token, including a list of most likely tokens if 'top_logprobs' were requested.
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.
ContentFilterBlocklistIdResult - Class in com.azure.ai.openai.models: Represents the outcome of an evaluation against a custom blocklist as performed by content filtering.
ContentFilterCitedDetectionResult - Class in com.azure.ai.openai.models: Represents the outcome of a detection operation against protected resources as performed by content filtering.
ContentFilterDetectionResult - Class in com.azure.ai.openai.models: Represents the outcome of a detection operation performed by content filtering.
ContentFilterResult - Class in com.azure.ai.openai.models: Information about filtered content severity level and if it has been filtered or not.
ContentFilterResultDetailsForPrompt - Class in com.azure.ai.openai.models: Information about content filtering evaluated against input data to Azure OpenAI.
ContentFilterResultsForChoice - Class in com.azure.ai.openai.models: Information about content filtering evaluated against generated model output.
ContentFilterResultsForPrompt - Class in com.azure.ai.openai.models: Content filtering results for a single prompt in the request.
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(KeyCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .
credential(TokenCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder: .

E

ECHO - Static variable in class com.azure.ai.openai.models.SpeechVoice: The Echo voice.
ElasticsearchChatExtensionConfiguration - Class in com.azure.ai.openai.models: A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat extension.
ElasticsearchChatExtensionConfiguration(ElasticsearchChatExtensionParameters) - Constructor for class com.azure.ai.openai.models.ElasticsearchChatExtensionConfiguration: Creates an instance of ElasticsearchChatExtensionConfiguration class.
ElasticsearchChatExtensionParameters - Class in com.azure.ai.openai.models: Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension.
ElasticsearchChatExtensionParameters(String, String) - Constructor for class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Creates an instance of ElasticsearchChatExtensionParameters class.
ElasticsearchIndexFieldMappingOptions - Class in com.azure.ai.openai.models: Optional settings to control how fields are processed when using a configured Elasticsearch® resource.
ElasticsearchIndexFieldMappingOptions() - Constructor for class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Creates an instance of ElasticsearchIndexFieldMappingOptions class.
ElasticsearchQueryType - Class in com.azure.ai.openai.models: The type of Elasticsearch® retrieval query that should be executed when using it as an Azure OpenAI chat extension.
ElasticsearchQueryType() - Constructor for class com.azure.ai.openai.models.ElasticsearchQueryType: Deprecated.
Use the ElasticsearchQueryType.fromString(String) factory method.
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

FABLE - Static variable in class com.azure.ai.openai.models.SpeechVoice: The Fable voice.
FLAC - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat: Use FLAC as the audio output format.
fromString(String) - Static method in class com.azure.ai.openai.models.AudioTaskLabel: Creates or finds a AudioTaskLabel from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.AudioTranscriptionFormat: Creates or finds a AudioTranscriptionFormat from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.AudioTranslationFormat: Creates or finds a AudioTranslationFormat from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.AzureSearchQueryType: Creates or finds a AzureSearchQueryType from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.ChatCompletionsToolSelectionPreset: Creates or finds a ChatCompletionsToolSelectionPreset from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.ChatMessageImageDetailLevel: Creates or finds a ChatMessageImageDetailLevel 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.ElasticsearchQueryType: Creates or finds a ElasticsearchQueryType from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.ImageGenerationQuality: Creates or finds a ImageGenerationQuality from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.ImageGenerationResponseFormat: Creates or finds a ImageGenerationResponseFormat from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.ImageGenerationStyle: Creates or finds a ImageGenerationStyle 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.SpeechGenerationResponseFormat: Creates or finds a SpeechGenerationResponseFormat from its string representation.
fromString(String) - Static method in class com.azure.ai.openai.models.SpeechVoice: Creates or finds a SpeechVoice from its string representation.
FUNCTION - Static variable in class com.azure.ai.openai.models.ChatRole: The role that provides function results for chat 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

generateSpeechFromText(String, SpeechGenerationOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Generates text-to-speech audio from the input text.
generateSpeechFromText(String, SpeechGenerationOptions) - Method in class com.azure.ai.openai.OpenAIClient: Generates text-to-speech audio from the input text.
generateSpeechFromTextWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Generates text-to-speech audio from the input text.
generateSpeechFromTextWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Generates text-to-speech audio from the input text.
getAccessToken() - Method in class com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions: Get the accessToken property: The access token to use for authentication.
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.
getAudioTranscription(String, String, AudioTranscriptionOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscription(String, String, AudioTranscriptionOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscriptionAsPlainText(String, AudioTranscriptionOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets transcribed text and associated metadata from provided spoken audio data.
getAudioTranscriptionAsPlainText(String, AudioTranscriptionOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets transcribed text and associated metadata from provided spoken audio data.
getAudioTranscriptionText(String, String, AudioTranscriptionOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscriptionText(String, String, AudioTranscriptionOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscriptionTextWithResponse(String, String, AudioTranscriptionOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscriptionTextWithResponse(String, String, AudioTranscriptionOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscriptionWithResponse(String, String, AudioTranscriptionOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranscriptionWithResponse(String, String, AudioTranscriptionOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslation(String, String, AudioTranslationOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslation(String, String, AudioTranslationOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslationAsPlainText(String, AudioTranslationOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets English language transcribed text and associated metadata from provided spoken audio data.
getAudioTranslationAsPlainText(String, AudioTranslationOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets English language transcribed text and associated metadata from provided spoken audio data.
getAudioTranslationText(String, String, AudioTranslationOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslationText(String, String, AudioTranslationOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslationTextWithResponse(String, String, AudioTranslationOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslationTextWithResponse(String, String, AudioTranslationOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslationWithResponse(String, String, AudioTranslationOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAudioTranslationWithResponse(String, String, AudioTranslationOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets English language transcribed text and associated metadata from provided spoken audio file data.
getAuthentication() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the authentication property: The authentication method to use when accessing the defined data source.
getAuthentication() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the authentication property: The authentication method to use when accessing the defined data source.
getAuthentication() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the authentication property: The authentication method to use when accessing the defined data source.
getAuthentication() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the authentication property: The authentication method to use when accessing the defined data source.
getAuthentication() - Method in class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource: Get the authentication property: Specifies the authentication options to use when retrieving embeddings from the specified endpoint.
getAuthentication() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the authentication property: The authentication method to use when accessing the defined data source.
getAvgLogprob() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the avgLogprob property: The average log probability associated with this audio segment.
getAvgLogprob() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the avgLogprob property: The average log probability associated with this audio segment.
getBase64Data() - Method in class com.azure.ai.openai.models.ImageGenerationData: Get the base64Data property: The complete data for an image, represented as a base64-encoded string.
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.
getBytes() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityInfo: Get the bytes property: A list of integers representing the UTF-8 bytes representation of the token.
getBytes() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityResult: Get the bytes property: A list of integers representing the UTF-8 bytes representation of the token.
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 in streaming mode.
getChatCompletionsStreamWithResponse(String, ChatCompletionsOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets chat completions for the provided chat messages.
getChatCompletionsStreamWithResponse(String, ChatCompletionsOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets chat completions for the provided chat messages in streaming mode.
getChatCompletionsWithResponse(String, ChatCompletionsOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets chat completions for the provided chat messages.
getChatCompletionsWithResponse(String, ChatCompletionsOptions, RequestOptions) - 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.
getChunkId() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation: Get the chunkId property: The chunk ID of the citation.
getCitations() - Method in class com.azure.ai.openai.models.AzureChatExtensionsMessageContext: Get the citations property: The contextual information associated with the Azure chat extensions used for a chat completions request.
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, CompletionsOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Gets completions for the provided input prompts.
getCompletionsWithResponse(String, CompletionsOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient: Gets completions 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.
getCompressionRatio() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the compressionRatio property: The compression ratio of this audio segment.
getCompressionRatio() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the compressionRatio property: The compression ratio of this audio segment.
getConnectionString() - Method in class com.azure.ai.openai.models.OnYourDataConnectionStringAuthenticationOptions: Get the connectionString property: The connection string to use for authentication.
getContainerName() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the containerName property: The name of the Azure Cosmos DB resource container.
getContent() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation: Get the content property: The content of the citation.
getContent() - Method in class com.azure.ai.openai.models.ChatChoiceLogProbabilityInfo: Get the content property: The list of log probability information entries for the choice's message content tokens, as requested via the 'logprobs' option.
getContent() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage: Get the content property: The content of the message.
getContent() - Method in class com.azure.ai.openai.models.ChatRequestFunctionMessage: Get the content property: The output of the function as requested by the function call.
getContent() - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage: Get the content property: The contents of the system message.
getContent() - Method in class com.azure.ai.openai.models.ChatRequestToolMessage: Get the content property: The content of the message.
getContent() - Method in class com.azure.ai.openai.models.ChatRequestUserMessage: Get the content property: The contents of the user message, with available input types varying by selected model.
getContent() - Method in class com.azure.ai.openai.models.ChatResponseMessage: Get the content property: The content of the message.
getContentFields() - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Get the contentFields property: The names of index fields that should be treated as content.
getContentFields() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the contentFields property: The names of index fields that should be treated as content.
getContentFields() - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Get the contentFields property: The names of index fields that should be treated as content.
getContentFields() - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Get the contentFields property: The names of index fields that should be treated as content.
getContentFieldsSeparator() - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Get the contentFieldsSeparator property: The separator pattern that content fields should use.
getContentFieldsSeparator() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the contentFieldsSeparator property: The separator pattern that content fields should use.
getContentFieldsSeparator() - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Get the contentFieldsSeparator property: The separator pattern that content fields should use.
getContentFieldsSeparator() - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Get the contentFieldsSeparator property: The separator pattern that content fields should use.
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.ContentFilterResultsForPrompt: Get the contentFilterResults property: Content filtering results for this prompt.
getContentFilterResults() - Method in class com.azure.ai.openai.models.ImageGenerationData: Get the contentFilterResults property: Information about the content filtering results.
getContext() - Method in class com.azure.ai.openai.models.ChatResponseMessage: Get the context property: If Azure OpenAI chat extensions are configured, this array represents the incremental steps performed by those extensions while processing the chat completions request.
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.
getCreatedAt() - Method in class com.azure.ai.openai.models.ImageGenerations: Get the createdAt property: A timestamp representing when this operation was started.
getCustomBlocklists() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: Get the customBlocklists property: Describes detection results against configured custom blocklists.
getCustomBlocklists() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the customBlocklists property: Describes detection results against configured custom blocklists.
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.ImageGenerations: Get the data property: The images generated by the operation.
getDatabaseName() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the databaseName property: The MongoDB vCore database name to use with Azure Cosmos DB.
getDataSources() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the dataSources property: The configuration entries for Azure OpenAI chat extensions that use them.
getDelta() - Method in class com.azure.ai.openai.models.ChatChoice: Get the delta property: The delta message content for a streaming response.
getDeploymentName() - Method in class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource: Get the deploymentName property: The embedding model deployment name within the same Azure OpenAI resource.
getDescription() - Method in class com.azure.ai.openai.models.FunctionDefinition: Get the description property: A description of what the function does.
getDetail() - Method in class com.azure.ai.openai.models.ChatMessageImageUrl: Get the detail property: The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and accuracy.
getDimensions() - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Get the dimensions property: The number of dimensions the resulting output embeddings should have.
getDuration() - Method in class com.azure.ai.openai.models.AudioTranscription: Get the duration property: The total duration of the audio processed to produce accompanying transcription information.
getDuration() - Method in class com.azure.ai.openai.models.AudioTranslation: Get the duration property: The total duration of the audio processed to produce accompanying translation information.
getEmbedding() - Method in class com.azure.ai.openai.models.EmbeddingItem: Get the embedding property: List of embeddings value for the input prompt.
getEmbeddingAsString() - Method in class com.azure.ai.openai.models.EmbeddingItem: Get the embedding property: List of embeddings value in base64 format for the input prompt.
getEmbeddingDependency() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the embeddingDependency property: The embedding dependency for vector search.
getEmbeddingDependency() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the embeddingDependency property: The embedding dependency for vector search.
getEmbeddingDependency() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the embeddingDependency property: The embedding dependency for vector search.
getEmbeddingDependency() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the embeddingDependency property: The embedding dependency for vector search.
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, EmbeddingsOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Return the embeddings for a given prompt.
getEmbeddingsWithResponse(String, EmbeddingsOptions, RequestOptions) - 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.
getEncodedApiKey() - Method in class com.azure.ai.openai.models.OnYourDataEncodedApiKeyAuthenticationOptions: Get the encodedApiKey property: The encoded API key to use for authentication.
getEnd() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the end property: The time at which this segment ended relative to the beginning of the transcribed audio.
getEnd() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the end property: The time at which this segment ended relative to the beginning of the translated audio.
getEndpoint() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the endpoint property: The absolute endpoint path for the Azure Cognitive Search resource to use.
getEndpoint() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the endpoint property: The endpoint of Elasticsearch®.
getEndpoint() - Method in class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource: Get the endpoint property: Specifies the resource endpoint URL from which embeddings should be retrieved.
getEnhancements() - Method in class com.azure.ai.openai.models.ChatChoice: Get the enhancements property: Represents the output results of Azure OpenAI enhancements to chat completions, as configured via the matching input provided in the request.
getEnhancements() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the enhancements property: If provided, the configuration options for available Azure OpenAI chat enhancements.
getEnvironment() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the environment property: The environment name of Pinecone.
getError() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: Get the error property: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time.
getError() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the error property: Describes an error returned if the content filtering system is down or otherwise unable to complete the operation in time.
getFieldsMapping() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
getFieldsMapping() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
getFieldsMapping() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the fieldsMapping property: The index field mapping options of Elasticsearch®.
getFieldsMapping() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
getFile() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Get the file property: The audio data to transcribe.
getFile() - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Get the file property: The audio data to translate.
getFilename() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Get the filename property: The optional filename or descriptive identifier to associate with with the audio data.
getFilename() - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Get the filename property: The optional filename or descriptive identifier to associate with with the audio data.
getFilepath() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation: Get the filepath property: The file path of the citation.
getFilepathField() - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Get the filepathField property: The name of the index field to use as a filepath.
getFilepathField() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the filepathField property: The name of the index field to use as a filepath.
getFilepathField() - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Get the filepathField property: The name of the index field to use as a filepath.
getFilepathField() - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Get the filepathField property: The name of the index field to use as a filepath.
getFilter() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the filter property: Search filter.
getFilter() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the filter property: Search filter.
getFinishDetails() - Method in class com.azure.ai.openai.models.ChatChoice: Get the finishDetails property: The reason the model stopped generating tokens, together with any applicable details.
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.
getFunction() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolCall: Get the function property: The details of the function invocation requested by the tool call.
getFunction() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition: Get the function property: The function definition details for the function tool.
getFunction() - Method in class com.azure.ai.openai.models.ChatCompletionsNamedFunctionToolSelection: Get the function property: The function that should be called.
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.ChatRequestAssistantMessage: Get the functionCall property: The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.
getFunctionCall() - Method in class com.azure.ai.openai.models.ChatResponseMessage: Get the functionCall property: The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.
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.
getGrounding() - Method in class com.azure.ai.openai.models.AzureChatEnhancementConfiguration: Get the grounding property: A representation of the available options for the Azure OpenAI grounding enhancement.
getGrounding() - Method in class com.azure.ai.openai.models.AzureChatEnhancements: Get the grounding property: The grounding enhancement that returns the bounding box of the objects detected in the image.
getHate() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: 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.
getHate() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: 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.
getHate() - Method in class com.azure.ai.openai.models.ImageGenerationContentFilterResults: 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.
getHate() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults: 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.AudioTranscriptionSegment: Get the id property: The 0-based index of this segment within a transcription.
getId() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the id property: The 0-based index of this segment within a translation.
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.ChatCompletionsToolCall: Get the id property: The ID of the tool call.
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.ContentFilterBlocklistIdResult: Get the id property: The ID of the custom blocklist evaluated.
getImageGenerations(String, ImageGenerationOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient: Creates an image given a prompt.
getImageGenerations(String, ImageGenerationOptions) - Method in class com.azure.ai.openai.OpenAIClient: Creates an image given a prompt.
getImageUrl() - Method in class com.azure.ai.openai.models.ChatMessageImageContentItem: Get the imageUrl property: An internet location, which must be accessible to the model,from which the image may be retrieved.
getImageVectorFields() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the imageVectorFields property: The names of fields that represent image vector data.
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.
getIndexName() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the indexName property: The MongoDB vCore index name to use with Azure Cosmos DB.
getIndexName() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the indexName property: The name of the index to use as available in the referenced Azure Cognitive Search resource.
getIndexName() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the indexName property: The index name of Elasticsearch®.
getIndexName() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the indexName property: The name of the Pinecone database index.
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.
getInput() - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Get the input property: The text to generate audio for.
getInputType() - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Get the inputType property: When using Azure OpenAI, specifies the input type to use for embedding search.
getIntent() - Method in class com.azure.ai.openai.models.AzureChatExtensionsMessageContext: Get the intent property: The detected intent from the chat history, used to pass to the next turn to carry over the context.
getJailbreak() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: Get the jailbreak property: Whether a jailbreak attempt was detected in the prompt.
getJailbreak() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults: Get the jailbreak property: Whether a jailbreak attempt was detected in the prompt.
getKey() - Method in class com.azure.ai.openai.models.OnYourDataApiKeyAuthenticationOptions: Get the key property: The API key to use for authentication.
getKey() - Method in class com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions: Get the key property: The key to use for authentication.
getKeyId() - Method in class com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions: Get the keyId property: The key ID to use for authentication.
getLanguage() - Method in class com.azure.ai.openai.models.AudioTranscription: Get the language property: The spoken language that was detected in the transcribed audio data.
getLanguage() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Get the language property: The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code such as 'en' or 'fr'.
getLanguage() - Method in class com.azure.ai.openai.models.AudioTranslation: Get the language property: The spoken language that was detected in the translated audio data.
getLatest() - Static method in enum com.azure.ai.openai.OpenAIServiceVersion: Gets the latest service version supported by this client library.
getLength() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLineSpan: Get the length property: The length of the span in characters, measured in Unicode codepoints.
getLicense() - Method in class com.azure.ai.openai.models.ContentFilterCitedDetectionResult: Get the license property: The license description associated with the detection.
getLines() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancement: Get the lines property: The lines of text detected by the grounding enhancement.
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.
getLogprob() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityInfo: Get the logprob property: The log probability of the message content token.
getLogprob() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityResult: Get the logprob property: The log probability of the message content token.
getLogprobs() - Method in class com.azure.ai.openai.models.ChatChoice: Get the logprobs property: The log probability information for this choice, as enabled via the 'logprobs' request option.
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.
getManagedIdentityResourceId() - Method in class com.azure.ai.openai.models.OnYourDataUserAssignedManagedIdentityAuthenticationOptions: Get the managedIdentityResourceId property: The resource ID of the user-assigned managed identity to use for authentication.
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.AudioTranscriptionOptions: Get the model property: The model to use for this transcription request.
getModel() - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Get the model property: The model to use for this translation 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.
getModel() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the model property: The model name or Azure OpenAI model deployment name to use for image generation.
getModel() - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Get the model property: The model to use for this text-to-speech request.
getModelId() - Method in class com.azure.ai.openai.models.OnYourDataModelIdVectorizationSource: Get the modelId property: The embedding model ID build inside the search service.
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.
getName() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the name property: The Azure Machine Learning vector index name.
getName() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolSelection: Get the name property: The name of the function that should be called.
getName() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage: Get the name property: An optional name for the participant.
getName() - Method in class com.azure.ai.openai.models.ChatRequestFunctionMessage: Get the name property: The name of the function that was called to produce output.
getName() - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage: Get the name property: An optional name for the participant.
getName() - Method in class com.azure.ai.openai.models.ChatRequestUserMessage: Get the name property: An optional name for the participant.
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.
getNoSpeechProb() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the noSpeechProb property: The probability of no speech detection within this audio segment.
getNoSpeechProb() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the noSpeechProb property: The probability of no speech detection within this audio segment.
getOcr() - Method in class com.azure.ai.openai.models.AzureChatEnhancementConfiguration: Get the ocr property: A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.
getOffset() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLineSpan: Get the offset property: The character offset within the text where the span begins.
getParameters() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionConfiguration: Get the parameters property: The parameters to use when configuring Azure OpenAI CosmosDB chat extensions.
getParameters() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionConfiguration: Get the parameters property: The parameters for the Azure Machine Learning vector index chat extension.
getParameters() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionConfiguration: Get the parameters property: The parameters to use when configuring Azure Search.
getParameters() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionConfiguration: Get the parameters property: The parameters to use when configuring Elasticsearch®.
getParameters() - Method in class com.azure.ai.openai.models.FunctionDefinition: Get the parameters property: The parameters the function accepts, described as a JSON Schema object.
getParameters() - Method in class com.azure.ai.openai.models.PineconeChatExtensionConfiguration: Get the parameters property: The parameters to use when configuring Azure OpenAI chat extensions.
getPolygon() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLineSpan: Get the polygon property: An array of objects representing points in the polygon that encloses the detected 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.
getProfanity() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: Get the profanity property: Describes whether profanity was detected.
getProfanity() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the profanity property: Describes whether profanity was detected.
getProfanity() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults: Get the profanity property: Describes whether profanity was detected.
getProjectResourceId() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the projectResourceId property: The resource ID of the Azure Machine Learning project.
getPrompt() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Get the prompt property: An optional hint to guide the model's style or continue from a prior audio segment.
getPrompt() - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Get the prompt property: An optional hint to guide the model's style or continue from a prior audio segment.
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.
getPromptFilterResults() - Method in class com.azure.ai.openai.models.ImageGenerationData: Get the promptFilterResults 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.
getPromptIndex() - Method in class com.azure.ai.openai.models.ContentFilterResultsForPrompt: Get the promptIndex property: The index of this prompt in the set of prompt results.
getPromptIndex() - Method in class com.azure.ai.openai.models.EmbeddingItem: Get the promptIndex property: Index of the prompt to which the EmbeddingItem corresponds.
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.
getProtectedMaterialCode() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the protectedMaterialCode property: Information about detection of protected code material.
getProtectedMaterialText() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the protectedMaterialText property: Information about detection of protected text material.
getQuality() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the quality property: The desired image generation quality level to use.
getQueryType() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the queryType property: The query type to use with Azure Cognitive Search.
getQueryType() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the queryType property: The query type of Elasticsearch®.
getResponseFormat() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Get the responseFormat property: The requested format of the transcription response data, which will influence the content and detail of the result.
getResponseFormat() - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Get the responseFormat property: The requested format of the translation response data, which will influence the content and detail of the result.
getResponseFormat() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the responseFormat property: An object specifying the format that the model must output.
getResponseFormat() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the responseFormat property: The format in which image generation response items should be presented.
getResponseFormat() - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Get the responseFormat property: The audio output format for the spoken text.
getRevisedPrompt() - Method in class com.azure.ai.openai.models.ImageGenerationData: Get the revisedPrompt property: The final prompt used by the model to generate the image.
getRole() - Method in class com.azure.ai.openai.models.ChatResponseMessage: Get the role property: The chat role associated with the message.
getRoleInformation() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
getRoleInformation() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
getRoleInformation() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
getRoleInformation() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
getRoleInformation() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
getSeed() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get 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.
getSeek() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the seek property: The seek position associated with the processing of this audio segment.
getSeek() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the seek property: The seek position associated with the processing of this audio segment.
getSegments() - Method in class com.azure.ai.openai.models.AudioTranscription: Get the segments property: A collection of information about the timing, probabilities, and other detail of each processed audio segment.
getSegments() - Method in class com.azure.ai.openai.models.AudioTranslation: Get the segments property: A collection of information about the timing, probabilities, and other detail of each processed audio segment.
getSelfHarm() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
getSelfHarm() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
getSelfHarm() - Method in class com.azure.ai.openai.models.ImageGenerationContentFilterResults: Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
getSelfHarm() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults: Get the selfHarm property: Describes language related to physical actions intended to purposely hurt, injure, or damage one’s body, or kill oneself.
getSemanticConfiguration() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the semanticConfiguration property: The additional semantic configuration for the query.
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.ContentFilterResultDetailsForPrompt: 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.
getSexual() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: 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.
getSexual() - Method in class com.azure.ai.openai.models.ImageGenerationContentFilterResults: 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.
getSexual() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults: 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 dimensions for generated images.
getSpans() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLine: Get the spans property: An array of spans that represent detected objects and its bounding box information.
getSpeed() - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Get the speed property: The speed of speech for generated audio.
getStart() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the start property: The time at which this segment started relative to the beginning of the transcribed audio.
getStart() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the start property: The time at which this segment started relative to the beginning of the translated audio.
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.
getStop() - Method in class com.azure.ai.openai.models.StopFinishDetails: Get the stop property: The token sequence that the model terminated with.
getStrictness() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the strictness property: The configured strictness of the search relevance filtering.
getStrictness() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the strictness property: The configured strictness of the search relevance filtering.
getStrictness() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the strictness property: The configured strictness of the search relevance filtering.
getStrictness() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the strictness property: The configured strictness of the search relevance filtering.
getStrictness() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the strictness property: The configured strictness of the search relevance filtering.
getStyle() - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Get the style property: The desired image generation style to use.
getSuffix() - Method in class com.azure.ai.openai.models.CompletionsOptions: Get the suffix property: The suffix that comes after a completion of inserted text.
getSystemFingerprint() - Method in class com.azure.ai.openai.models.ChatCompletions: Get the systemFingerprint property: Can be used in conjunction with the `seed` request parameter to understand when backend changes have been made that might impact determinism.
getTask() - Method in class com.azure.ai.openai.models.AudioTranscription: Get the task property: The label that describes which operation type generated the accompanying response data.
getTask() - Method in class com.azure.ai.openai.models.AudioTranslation: Get the task property: The label that describes which operation type generated the accompanying response data.
getTemperature() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Get the temperature property: The sampling temperature, between 0 and 1.
getTemperature() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the temperature property: The temperature score associated with this audio segment.
getTemperature() - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Get the temperature property: The sampling temperature, between 0 and 1.
getTemperature() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the temperature property: The temperature score associated with this audio segment.
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.AudioTranscription: Get the text property: The transcribed text for the provided audio data.
getText() - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment: Get the text property: The transcribed text that was part of this audio segment.
getText() - Method in class com.azure.ai.openai.models.AudioTranslation: Get the text property: The translated text for the provided audio data.
getText() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the text property: The translated text that was part of this audio segment.
getText() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLine: Get the text property: The text within the line.
getText() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLineSpan: Get the text property: The text content of the span that represents the detected object.
getText() - Method in class com.azure.ai.openai.models.ChatMessageTextContentItem: Get the text property: The content of the message.
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.
getTitle() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation: Get the title property: The title of the citation.
getTitleField() - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Get the titleField property: The name of the index field to use as a title.
getTitleField() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the titleField property: The name of the index field to use as a title.
getTitleField() - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Get the titleField property: The name of the index field to use as a title.
getTitleField() - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Get the titleField property: The name of the index field to use as a title.
getToken() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityInfo: Get the token property: The message content token.
getToken() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityResult: Get the token property: The message content token.
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.AudioTranscriptionSegment: Get the tokens property: The token IDs matching the transcribed text in this audio segment.
getTokens() - Method in class com.azure.ai.openai.models.AudioTranslationSegment: Get the tokens property: The token IDs matching the translated text in this audio segment.
getTokens() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel: Get the tokens property: The textual forms of tokens evaluated in this probability model.
getToolCallId() - Method in class com.azure.ai.openai.models.ChatRequestToolMessage: Get the toolCallId property: The ID of the tool call resolved by the provided content.
getToolCalls() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage: Get the toolCalls property: The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.
getToolCalls() - Method in class com.azure.ai.openai.models.ChatResponseMessage: Get the toolCalls property: The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.
getToolChoice() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the toolChoice property: If specified, the model will configure which of the provided tools it can use for the chat completions response.
getTools() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the tools property: The available tool definitions that the chat completions request can use, including caller-defined functions.
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.
getTopLogprobs() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get 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.
getTopLogprobs() - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityResult: Get the topLogprobs property: The list of most likely tokens and their log probability information, as requested via 'top_logprobs'.
getTopNDocuments() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the topNDocuments property: The configured top number of documents to feature for the configured query.
getTopNDocuments() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the topNDocuments property: The configured top number of documents to feature for the configured query.
getTopNDocuments() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the topNDocuments property: The configured top number of documents to feature for the configured query.
getTopNDocuments() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the topNDocuments property: The configured top number of documents to feature for the configured query.
getTopNDocuments() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the topNDocuments property: The configured top number of documents to feature for the configured query.
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.
getType() - Method in class com.azure.ai.openai.models.ChatCompletionsToolCall: Get the type property: The type pf the tool call.
getUrl() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation: Get the url property: The URL of the citation.
getUrl() - Method in class com.azure.ai.openai.models.ChatMessageImageUrl: Get the url property: The URL of the image.
getUrl() - Method in class com.azure.ai.openai.models.ContentFilterCitedDetectionResult: Get the url property: The internet location associated with the detection.
getUrl() - Method in class com.azure.ai.openai.models.ImageGenerationData: Get the url property: The URL that provides temporary access to download the generated image.
getUrlField() - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Get the urlField property: The name of the index field to use as a URL.
getUrlField() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the urlField property: The name of the index field to use as a URL.
getUrlField() - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Get the urlField property: The name of the index field to use as a URL.
getUrlField() - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Get the urlField property: The name of the index field to use as a URL.
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.
getVectorFields() - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Get the vectorFields property: The names of fields that represent vector data.
getVectorFields() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Get the vectorFields property: The names of fields that represent vector data.
getVectorFields() - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Get the vectorFields property: The names of fields that represent vector data.
getVersion() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the version property: The version of the Azure Machine Learning vector index.
getVersion() - Method in enum com.azure.ai.openai.OpenAIServiceVersion
getViolence() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt: Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.
getViolence() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice: Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.
getViolence() - Method in class com.azure.ai.openai.models.ImageGenerationContentFilterResults: Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.
getViolence() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults: Get the violence property: Describes language related to physical actions intended to hurt, injure, damage, or kill someone or something; describes weapons, etc.
getVoice() - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Get the voice property: The voice to use for text-to-speech.
getX() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementCoordinatePoint: Get the x property: The x-coordinate (horizontal axis) of the point.
getY() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementCoordinatePoint: Get the y property: The y-coordinate (vertical axis) of the point.

H

HD - Static variable in class com.azure.ai.openai.models.ImageGenerationQuality: Requests image generation with higher quality, higher cost and lower speed relative to standard.
HIGH - Static variable in class com.azure.ai.openai.models.ChatMessageImageDetailLevel: Specifies that image evaluation should enable the 'high-res' model that may be more accurate for highly detailed images but may also be slower and consume more tokens.
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

ImageGenerationContentFilterResults - Class in com.azure.ai.openai.models: Describes the content filtering result for the image generation request.
ImageGenerationData - Class in com.azure.ai.openai.models: A representation of a single generated image, provided as either base64-encoded data or as a URL from which the image may be retrieved.
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.
ImageGenerationPromptFilterResults - Class in com.azure.ai.openai.models: Describes the content filtering results for the prompt of a image generation request.
ImageGenerationQuality - Class in com.azure.ai.openai.models: An image generation configuration that specifies how the model should prioritize quality, cost, and speed.
ImageGenerationQuality() - Constructor for class com.azure.ai.openai.models.ImageGenerationQuality: Deprecated.
Use the ImageGenerationQuality.fromString(String) factory method.
ImageGenerationResponseFormat - Class in com.azure.ai.openai.models: The format in which the generated images are returned.
ImageGenerationResponseFormat() - Constructor for class com.azure.ai.openai.models.ImageGenerationResponseFormat: Deprecated.
Use the ImageGenerationResponseFormat.fromString(String) factory method.
ImageGenerations - Class in com.azure.ai.openai.models: The result of a successful image generation operation.
ImageGenerationStyle - Class in com.azure.ai.openai.models: An image generation configuration that specifies how the model should incorporate realism and other visual characteristics.
ImageGenerationStyle() - Constructor for class com.azure.ai.openai.models.ImageGenerationStyle: Deprecated.
Use the ImageGenerationStyle.fromString(String) factory method.
ImageSize - Class in com.azure.ai.openai.models: The desired size of generated images.
ImageSize() - Constructor for class com.azure.ai.openai.models.ImageSize: Deprecated.
Use the ImageSize.fromString(String) factory method.
isDetected() - Method in class com.azure.ai.openai.models.ContentFilterCitedDetectionResult: Get the detected property: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered.
isDetected() - Method in class com.azure.ai.openai.models.ContentFilterDetectionResult: Get the detected property: A value indicating whether detection occurred, irrespective of severity or whether the content was filtered.
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.
isEnabled() - Method in class com.azure.ai.openai.models.AzureChatGroundingEnhancementConfiguration: Get the enabled property: Specifies whether the enhancement is enabled.
isEnabled() - Method in class com.azure.ai.openai.models.AzureChatOCREnhancementConfiguration: Get the enabled property: Specifies whether the enhancement is enabled.
isFiltered() - Method in class com.azure.ai.openai.models.ContentFilterBlocklistIdResult: Get the filtered property: A value indicating whether or not the content has been filtered.
isFiltered() - Method in class com.azure.ai.openai.models.ContentFilterCitedDetectionResult: Get the filtered property: A value indicating whether or not the content has been filtered.
isFiltered() - Method in class com.azure.ai.openai.models.ContentFilterDetectionResult: Get the filtered property: A value indicating whether or not the content has been filtered.
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.
isInScope() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Get the inScope property: Whether queries should be restricted to use of indexed data.
isInScope() - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Get the inScope property: Whether queries should be restricted to use of indexed data.
isInScope() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Get the inScope property: Whether queries should be restricted to use of indexed data.
isInScope() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Get the inScope property: Whether queries should be restricted to use of indexed data.
isInScope() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Get the inScope property: Whether queries should be restricted to use of indexed data.
isLogprobs() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Get the logprobs property: Whether to return log probabilities of the output tokens or not.
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.

J

JSON - Static variable in class com.azure.ai.openai.models.AudioTranscriptionFormat: Use a response body that is a JSON object containing a single 'text' field for the transcription.
JSON - Static variable in class com.azure.ai.openai.models.AudioTranslationFormat: Use a response body that is a JSON object containing a single 'text' field for the translation.

L

LOW - Static variable in class com.azure.ai.openai.models.ChatMessageImageDetailLevel: Specifies that image evaluation should be constrained to the 'low-res' model that may be faster and consume fewer tokens but may also be less accurate for highly detailed images.
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

MaxTokensFinishDetails - Class in com.azure.ai.openai.models: A structured representation of a stop reason that signifies a token limit was reached before the model could naturally complete.
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.
MP3 - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat: Use MP3 as the audio output format.

N

NATURAL - Static variable in class com.azure.ai.openai.models.ImageGenerationStyle: Requests image generation in a natural style with less preference for dramatic and hyper-realistic characteristics.
NONE - Static variable in class com.azure.ai.openai.models.ChatCompletionsToolSelectionPreset: Specifies that the model should not respond with a tool call and should instead provide a standard chat completions response.
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.
NOVA - Static variable in class com.azure.ai.openai.models.SpeechVoice: The Nova voice.

O

OnYourDataAccessTokenAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using access token.
OnYourDataAccessTokenAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions: Creates an instance of OnYourDataAccessTokenAuthenticationOptions class.
OnYourDataApiKeyAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using an API key.
OnYourDataApiKeyAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataApiKeyAuthenticationOptions: Creates an instance of OnYourDataApiKeyAuthenticationOptions class.
OnYourDataAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data.
OnYourDataAuthenticationOptions() - Constructor for class com.azure.ai.openai.models.OnYourDataAuthenticationOptions: Creates an instance of OnYourDataAuthenticationOptions class.
OnYourDataConnectionStringAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using a connection string.
OnYourDataConnectionStringAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataConnectionStringAuthenticationOptions: Creates an instance of OnYourDataConnectionStringAuthenticationOptions class.
OnYourDataDeploymentNameVectorizationSource - Class in com.azure.ai.openai.models: The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on an internal embeddings model deployment name in the same Azure OpenAI resource.
OnYourDataDeploymentNameVectorizationSource(String) - Constructor for class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource: Creates an instance of OnYourDataDeploymentNameVectorizationSource class.
OnYourDataEncodedApiKeyAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.
OnYourDataEncodedApiKeyAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataEncodedApiKeyAuthenticationOptions: Creates an instance of OnYourDataEncodedApiKeyAuthenticationOptions class.
OnYourDataEndpointVectorizationSource - Class in com.azure.ai.openai.models: The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a public Azure OpenAI endpoint call for embeddings.
OnYourDataEndpointVectorizationSource(String, OnYourDataAuthenticationOptions) - Constructor for class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource: Creates an instance of OnYourDataEndpointVectorizationSource class.
OnYourDataKeyAndKeyIdAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using an Elasticsearch key and key ID pair.
OnYourDataKeyAndKeyIdAuthenticationOptions(String, String) - Constructor for class com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions: Creates an instance of OnYourDataKeyAndKeyIdAuthenticationOptions class.
OnYourDataModelIdVectorizationSource - Class in com.azure.ai.openai.models: The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a search service model ID.
OnYourDataModelIdVectorizationSource(String) - Constructor for class com.azure.ai.openai.models.OnYourDataModelIdVectorizationSource: Creates an instance of OnYourDataModelIdVectorizationSource class.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using a system-assigned managed identity.
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions() - Constructor for class com.azure.ai.openai.models.OnYourDataSystemAssignedManagedIdentityAuthenticationOptions: Creates an instance of OnYourDataSystemAssignedManagedIdentityAuthenticationOptions class.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions - Class in com.azure.ai.openai.models: The authentication options for Azure OpenAI On Your Data when using a user-assigned managed identity.
OnYourDataUserAssignedManagedIdentityAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataUserAssignedManagedIdentityAuthenticationOptions: Creates an instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions class.
OnYourDataVectorizationSource - Class in com.azure.ai.openai.models: An abstract representation of a vectorization source for Azure OpenAI On Your Data with vector search.
OnYourDataVectorizationSource() - Constructor for class com.azure.ai.openai.models.OnYourDataVectorizationSource: Creates an instance of OnYourDataVectorizationSource class.
ONYX - Static variable in class com.azure.ai.openai.models.SpeechVoice: The Onyx voice.
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.
OPUS - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat: Use Opus as the audio output format.

P

PineconeChatExtensionConfiguration - Class in com.azure.ai.openai.models: A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat extension.
PineconeChatExtensionConfiguration(PineconeChatExtensionParameters) - Constructor for class com.azure.ai.openai.models.PineconeChatExtensionConfiguration: Creates an instance of PineconeChatExtensionConfiguration class.
PineconeChatExtensionParameters - Class in com.azure.ai.openai.models: Parameters for configuring Azure OpenAI Pinecone chat extensions.
PineconeChatExtensionParameters(String, String, PineconeFieldMappingOptions, OnYourDataVectorizationSource) - Constructor for class com.azure.ai.openai.models.PineconeChatExtensionParameters: Creates an instance of PineconeChatExtensionParameters class.
PineconeFieldMappingOptions - Class in com.azure.ai.openai.models: Optional settings to control how fields are processed when using a configured Pinecone resource.
PineconeFieldMappingOptions(List<String>) - Constructor for class com.azure.ai.openai.models.PineconeFieldMappingOptions: Creates an instance of PineconeFieldMappingOptions class.
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

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.
SEMANTIC - Static variable in class com.azure.ai.openai.models.AzureSearchQueryType: Represents the semantic query parser for advanced semantic modeling.
serviceVersion(OpenAIServiceVersion) - Method in class com.azure.ai.openai.OpenAIClientBuilder: Sets Service version.
setAuthentication(OnYourDataAuthenticationOptions) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Set the authentication property: The authentication method to use when accessing the defined data source.
setAuthentication(OnYourDataAuthenticationOptions) - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Set the authentication property: The authentication method to use when accessing the defined data source.
setAuthentication(OnYourDataAuthenticationOptions) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the authentication property: The authentication method to use when accessing the defined data source.
setAuthentication(OnYourDataAuthenticationOptions) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the authentication property: The authentication method to use when accessing the defined data source.
setAuthentication(OnYourDataAuthenticationOptions) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Set the authentication property: The authentication method to use when accessing the defined data source.
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.
setContentFields(List<String>) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the contentFields property: The names of index fields that should be treated as content.
setContentFields(List<String>) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Set the contentFields property: The names of index fields that should be treated as content.
setContentFieldsSeparator(String) - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Set the contentFieldsSeparator property: The separator pattern that content fields should use.
setContentFieldsSeparator(String) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the contentFieldsSeparator property: The separator pattern that content fields should use.
setContentFieldsSeparator(String) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Set the contentFieldsSeparator property: The separator pattern that content fields should use.
setContentFieldsSeparator(String) - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Set the contentFieldsSeparator property: The separator pattern that content fields should use.
setDataSources(List<AzureChatExtensionConfiguration>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the dataSources property: The configuration entries for Azure OpenAI chat extensions that use them.
setDescription(String) - Method in class com.azure.ai.openai.models.FunctionDefinition: Set the description property: A description of what the function does.
setDetail(ChatMessageImageDetailLevel) - Method in class com.azure.ai.openai.models.ChatMessageImageUrl: Set the detail property: The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and accuracy.
setDimensions(Integer) - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Set the dimensions property: The number of dimensions the resulting output embeddings should have.
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.
setEmbeddingDependency(OnYourDataVectorizationSource) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the embeddingDependency property: The embedding dependency for vector search.
setEmbeddingDependency(OnYourDataVectorizationSource) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the embeddingDependency property: The embedding dependency for vector search.
setEnhancements(AzureChatEnhancementConfiguration) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the enhancements property: If provided, the configuration options for available Azure OpenAI chat enhancements.
setFieldsMapping(AzureSearchIndexFieldMappingOptions) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the fieldsMapping property: Customized field mapping behavior to use when interacting with the search index.
setFieldsMapping(ElasticsearchIndexFieldMappingOptions) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the fieldsMapping property: The index field mapping options of Elasticsearch®.
setFilename(String) - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Set the filename property: The optional filename or descriptive identifier to associate with with the audio data.
setFilename(String) - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Set the filename property: The optional filename or descriptive identifier to associate with with the audio data.
setFilepathField(String) - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Set the filepathField property: The name of the index field to use as a filepath.
setFilepathField(String) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the filepathField property: The name of the index field to use as a filepath.
setFilepathField(String) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Set the filepathField property: The name of the index field to use as a filepath.
setFilepathField(String) - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Set the filepathField property: The name of the index field to use as a filepath.
setFilter(String) - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Set the filter property: Search filter.
setFilter(String) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the filter property: Search filter.
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.ChatRequestAssistantMessage: Set the functionCall property: The function call that must be resolved and have its output appended to subsequent input messages for the chat completions request to resolve as configured.
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.
setGrounding(AzureChatGroundingEnhancementConfiguration) - Method in class com.azure.ai.openai.models.AzureChatEnhancementConfiguration: Set the grounding property: A representation of the available options for the Azure OpenAI grounding enhancement.
setImageVectorFields(List<String>) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the imageVectorFields property: The names of fields that represent image vector data.
setInputType(String) - Method in class com.azure.ai.openai.models.EmbeddingsOptions: Set the inputType property: When using Azure OpenAI, specifies the input type to use for embedding search.
setInScope(Boolean) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Set the inScope property: Whether queries should be restricted to use of indexed data.
setInScope(Boolean) - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Set the inScope property: Whether queries should be restricted to use of indexed data.
setInScope(Boolean) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the inScope property: Whether queries should be restricted to use of indexed data.
setInScope(Boolean) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the inScope property: Whether queries should be restricted to use of indexed data.
setInScope(Boolean) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Set the inScope property: Whether queries should be restricted to use of indexed data.
setLanguage(String) - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Set the language property: The primary spoken language of the audio data to be transcribed, supplied as a two-letter ISO-639-1 language code such as 'en' or 'fr'.
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(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the logprobs property: Whether to return log probabilities of the output tokens or not.
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.AudioTranscriptionOptions: Set the model property: The model to use for this transcription request.
setModel(String) - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Set the model property: The model to use for this translation request.
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.
setModel(String) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the model property: The model name or Azure OpenAI model deployment name to use for image generation.
setModel(String) - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Set the model property: The model to use for this text-to-speech 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.
setName(String) - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage: Set the name property: An optional name for the participant.
setName(String) - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage: Set the name property: An optional name for the participant.
setName(String) - Method in class com.azure.ai.openai.models.ChatRequestUserMessage: Set the name property: An optional name for the participant.
setOcr(AzureChatOCREnhancementConfiguration) - Method in class com.azure.ai.openai.models.AzureChatEnhancementConfiguration: Set the ocr property: A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.
setParameters(BinaryData) - Method in class com.azure.ai.openai.models.FunctionDefinition: Set the parameters property: The parameters the function 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.
setPrompt(String) - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Set the prompt property: An optional hint to guide the model's style or continue from a prior audio segment.
setPrompt(String) - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Set the prompt property: An optional hint to guide the model's style or continue from a prior audio segment.
setQuality(ImageGenerationQuality) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the quality property: The desired image generation quality level to use.
setQueryType(AzureSearchQueryType) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the queryType property: The query type to use with Azure Cognitive Search.
setQueryType(ElasticsearchQueryType) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the queryType property: The query type of Elasticsearch®.
setResponseFormat(AudioTranscriptionFormat) - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Set the responseFormat property: The requested format of the transcription response data, which will influence the content and detail of the result.
setResponseFormat(AudioTranslationFormat) - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Set the responseFormat property: The requested format of the translation response data, which will influence the content and detail of the result.
setResponseFormat(ChatCompletionsResponseFormat) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the responseFormat property: An object specifying the format that the model must output.
setResponseFormat(ImageGenerationResponseFormat) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the responseFormat property: The format in which image generation response items should be presented.
setResponseFormat(SpeechGenerationResponseFormat) - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Set the responseFormat property: The audio output format for the spoken text.
setRoleInformation(String) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
setRoleInformation(String) - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
setRoleInformation(String) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
setRoleInformation(String) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
setRoleInformation(String) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Set the roleInformation property: Give the model instructions about how it should behave and any context it should reference when generating a response.
setSeed(Long) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: 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.
setSemanticConfiguration(String) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the semanticConfiguration property: The additional semantic configuration for the query.
setSize(ImageSize) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the size property: The desired dimensions for generated images.
setSpeed(Double) - Method in class com.azure.ai.openai.models.SpeechGenerationOptions: Set the speed property: The speed of speech for generated audio.
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.
setStrictness(Integer) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Set the strictness property: The configured strictness of the search relevance filtering.
setStrictness(Integer) - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Set the strictness property: The configured strictness of the search relevance filtering.
setStrictness(Integer) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the strictness property: The configured strictness of the search relevance filtering.
setStrictness(Integer) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the strictness property: The configured strictness of the search relevance filtering.
setStrictness(Integer) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Set the strictness property: The configured strictness of the search relevance filtering.
setStyle(ImageGenerationStyle) - Method in class com.azure.ai.openai.models.ImageGenerationOptions: Set the style property: The desired image generation style to use.
setSuffix(String) - Method in class com.azure.ai.openai.models.CompletionsOptions: Set the suffix property: The suffix that comes after a completion of inserted text.
setTemperature(Double) - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions: Set the temperature property: The sampling temperature, between 0 and 1.
setTemperature(Double) - Method in class com.azure.ai.openai.models.AudioTranslationOptions: Set the temperature property: The sampling temperature, between 0 and 1.
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.
setTitleField(String) - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Set the titleField property: The name of the index field to use as a title.
setTitleField(String) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the titleField property: The name of the index field to use as a title.
setTitleField(String) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Set the titleField property: The name of the index field to use as a title.
setTitleField(String) - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Set the titleField property: The name of the index field to use as a title.
setToolCalls(List<ChatCompletionsToolCall>) - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage: Set the toolCalls property: The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.
setToolChoice(BinaryData) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the toolChoice property: If specified, the model will configure which of the provided tools it can use for the chat completions response.
setTools(List<ChatCompletionsToolDefinition>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: Set the tools property: The available tool definitions that the chat completions request can use, including caller-defined functions.
setTopLogprobs(Integer) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions: 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.
setTopNDocuments(Integer) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters: Set the topNDocuments property: The configured top number of documents to feature for the configured query.
setTopNDocuments(Integer) - Method in class com.azure.ai.openai.models.AzureMachineLearningIndexChatExtensionParameters: Set the topNDocuments property: The configured top number of documents to feature for the configured query.
setTopNDocuments(Integer) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters: Set the topNDocuments property: The configured top number of documents to feature for the configured query.
setTopNDocuments(Integer) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters: Set the topNDocuments property: The configured top number of documents to feature for the configured query.
setTopNDocuments(Integer) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters: Set the topNDocuments property: The configured top number of documents to feature for the configured query.
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.
setUrlField(String) - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions: Set the urlField property: The name of the index field to use as a URL.
setUrlField(String) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the urlField property: The name of the index field to use as a URL.
setUrlField(String) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Set the urlField property: The name of the index field to use as a URL.
setUrlField(String) - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions: Set the urlField property: The name of the index field to use as a URL.
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.
setVectorFields(List<String>) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions: Set the vectorFields property: The names of fields that represent vector data.
setVectorFields(List<String>) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions: Set the vectorFields property: The names of fields that represent vector data.
SHIMMER - Static variable in class com.azure.ai.openai.models.SpeechVoice: The Shimmer voice.
SIMPLE - Static variable in class com.azure.ai.openai.models.AzureSearchQueryType: Represents the default, simple query parser.
SIMPLE - Static variable in class com.azure.ai.openai.models.ElasticsearchQueryType: Represents the default, simple query parser.
SIZE1024X1024 - Static variable in class com.azure.ai.openai.models.ImageSize: A standard, square image size of 1024x1024 pixels.
SIZE1024X1792 - Static variable in class com.azure.ai.openai.models.ImageSize: A taller image size of 1792x1024 pixels.
SIZE1792X1024 - Static variable in class com.azure.ai.openai.models.ImageSize: A wider image size of 1024x1792 pixels.
SIZE256X256 - Static variable in class com.azure.ai.openai.models.ImageSize: Very small image size of 256x256 pixels.
SIZE512X512 - Static variable in class com.azure.ai.openai.models.ImageSize: A smaller image size of 512x512 pixels.
SpeechGenerationOptions - Class in com.azure.ai.openai.models: A representation of the request options that control the behavior of a text-to-speech operation.
SpeechGenerationOptions(String, SpeechVoice) - Constructor for class com.azure.ai.openai.models.SpeechGenerationOptions: Creates an instance of SpeechGenerationOptions class.
SpeechGenerationResponseFormat - Class in com.azure.ai.openai.models: The supported audio output formats for text-to-speech.
SpeechGenerationResponseFormat() - Constructor for class com.azure.ai.openai.models.SpeechGenerationResponseFormat: Deprecated.
Use the SpeechGenerationResponseFormat.fromString(String) factory method.
SpeechVoice - Class in com.azure.ai.openai.models: The available voices for text-to-speech.
SpeechVoice() - Constructor for class com.azure.ai.openai.models.SpeechVoice: Deprecated.
Use the SpeechVoice.fromString(String) factory method.
SRT - Static variable in class com.azure.ai.openai.models.AudioTranscriptionFormat: Use a response body that is plain text in SubRip (SRT) format that also includes timing information.
SRT - Static variable in class com.azure.ai.openai.models.AudioTranslationFormat: Use a response body that is plain text in SubRip (SRT) format that also includes timing information.
STANDARD - Static variable in class com.azure.ai.openai.models.ImageGenerationQuality: Requests image generation with standard, balanced characteristics of quality, cost, and speed.
StopFinishDetails - Class in com.azure.ai.openai.models: A structured representation of a stop reason that signifies natural termination by the model.
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

TEXT - Static variable in class com.azure.ai.openai.models.AudioTranscriptionFormat: Use a response body that is plain text containing the raw, unannotated transcription.
TEXT - Static variable in class com.azure.ai.openai.models.AudioTranslationFormat: Use a response body that is plain text containing the raw, unannotated translation.
TOKEN_LIMIT_REACHED - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completions exhausted available token limits before generation could complete.
TOOL - Static variable in class com.azure.ai.openai.models.ChatRole: The role that represents extension tool activity within a chat completions operation.
TOOL_CALLS - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason: Completion ended with the model calling a provided tool for output.
TRANSCRIBE - Static variable in class com.azure.ai.openai.models.AudioTaskLabel: Accompanying response data resulted from an audio transcription task.
TRANSLATE - Static variable in class com.azure.ai.openai.models.AudioTaskLabel: Accompanying response data resulted from an audio translation task.

U

URL - Static variable in class com.azure.ai.openai.models.ImageGenerationResponseFormat: Image generation response items should provide a URL from which the image may be retrieved.
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.
V2024_02_15_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2024-02-15-preview.
V2024_03_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion: Enum value 2024-03-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.AudioTaskLabel: Gets known AudioTaskLabel values.
values() - Static method in class com.azure.ai.openai.models.AudioTranscriptionFormat: Gets known AudioTranscriptionFormat values.
values() - Static method in class com.azure.ai.openai.models.AudioTranslationFormat: Gets known AudioTranslationFormat values.
values() - Static method in class com.azure.ai.openai.models.AzureSearchQueryType: Gets known AzureSearchQueryType values.
values() - Static method in class com.azure.ai.openai.models.ChatCompletionsToolSelectionPreset: Gets known ChatCompletionsToolSelectionPreset values.
values() - Static method in class com.azure.ai.openai.models.ChatMessageImageDetailLevel: Gets known ChatMessageImageDetailLevel 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.ElasticsearchQueryType: Gets known ElasticsearchQueryType values.
values() - Static method in class com.azure.ai.openai.models.ImageGenerationQuality: Gets known ImageGenerationQuality values.
values() - Static method in class com.azure.ai.openai.models.ImageGenerationResponseFormat: Gets known ImageGenerationResponseFormat values.
values() - Static method in class com.azure.ai.openai.models.ImageGenerationStyle: Gets known ImageGenerationStyle 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.SpeechGenerationResponseFormat: Gets known SpeechGenerationResponseFormat values.
values() - Static method in class com.azure.ai.openai.models.SpeechVoice: Gets known SpeechVoice 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.
VECTOR - Static variable in class com.azure.ai.openai.models.AzureSearchQueryType: Represents vector search over computed data.
VECTOR - Static variable in class com.azure.ai.openai.models.ElasticsearchQueryType: Represents vector search over computed data.
VECTOR_SEMANTIC_HYBRID - Static variable in class com.azure.ai.openai.models.AzureSearchQueryType: Represents a combination of semantic search and vector data querying.
VECTOR_SIMPLE_HYBRID - Static variable in class com.azure.ai.openai.models.AzureSearchQueryType: Represents a combination of the simple query strategy with vector data.
VERBOSE_JSON - Static variable in class com.azure.ai.openai.models.AudioTranscriptionFormat: Use a response body that is a JSON object containing transcription text along with timing, segments, and other metadata.
VERBOSE_JSON - Static variable in class com.azure.ai.openai.models.AudioTranslationFormat: Use a response body that is a JSON object containing translation text along with timing, segments, and other metadata.
VIVID - Static variable in class com.azure.ai.openai.models.ImageGenerationStyle: Requests image generation in a vivid style with a higher preference for dramatic and hyper-realistic characteristics.
VTT - Static variable in class com.azure.ai.openai.models.AudioTranscriptionFormat: Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information.
VTT - Static variable in class com.azure.ai.openai.models.AudioTranslationFormat: Use a response body that is plain text in Web Video Text Tracks (VTT) format that also includes timing information.

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