Index
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.
- ACCESS_TOKEN - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via access token.
- ACCESS_TOKEN - Static variable in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationType
-
Authentication via access token.
- Adding the package to your product - Search tag in Overview
- Section
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- addUploadPart(String, AddUploadPartRequest) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Adds a Part to an Upload object.
- addUploadPart(String, AddUploadPartRequest) - Method in class com.azure.ai.openai.OpenAIClient
-
Adds a Part to an Upload object.
- AddUploadPartRequest - Class in com.azure.ai.openai.models
-
The multipart/form-data request body of a data part addition request for an upload.
- AddUploadPartRequest(DataFileDetails) - Constructor for class com.azure.ai.openai.models.AddUploadPartRequest
-
Creates an instance of AddUploadPartRequest class.
- ALL_RETRIEVED_DOCUMENTS - Static variable in class com.azure.ai.openai.models.OnYourDataContextProperty
-
The `all_retrieved_documents` property.
- ALLOY - Static variable in class com.azure.ai.openai.models.SpeechVoice
-
The Alloy voice.
- API_KEY - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via API key.
- API_KEY - Static variable in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationType
-
Authentication via API key.
- APPLICATION_JSON - Enum constant in enum com.azure.ai.openai.responses.models.CreateResponseRequestAccept
-
Enum value application/json.
- ASC - Enum constant in enum com.azure.ai.openai.responses.models.ListInputItemsRequestOrder
-
Enum value asc.
- ASSISTANT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Enum value assistant.
- ASSISTANT - Static variable in class com.azure.ai.openai.models.ChatRole
-
The role that provides responses to system-instructed, user-prompted input.
- ASSISTANTS - Static variable in class com.azure.ai.openai.models.CreateUploadRequestPurpose
-
Static value assistants for CreateUploadRequestPurpose.
- ASSISTANTS - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used as input to assistants.
- ASSISTANTS - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value assistants for UploadPurpose.
- ASSISTANTS_OUTPUT - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used as output by assistants.
- ASSISTANTS_OUTPUT - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value assistants_output for UploadPurpose.
- AUDIO - Static variable in class com.azure.ai.openai.models.ChatCompletionModality
-
The model is to generate audio output.
- AudioOutputParameters - Class in com.azure.ai.openai.models
-
Describes the parameters for audio output.
- AudioOutputParameters(SpeechVoice, OutputAudioFormat) - Constructor for class com.azure.ai.openai.models.AudioOutputParameters
-
Creates an instance of AudioOutputParameters class.
- AudioResponseData - Class in com.azure.ai.openai.models
-
Object containing audio response data and its metadata.
- 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.
- AudioTranscription - Class in com.azure.ai.openai.models
-
Result information for an operation that transcribed spoken audio into written text.
- Audio Transcription - Search tag in Overview
- Section
- 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.
- AudioTranscriptionTimestampGranularity - Class in com.azure.ai.openai.models
-
Defines the timestamp granularities that can be requested on a verbose transcription response.
- AudioTranscriptionTimestampGranularity() - Constructor for class com.azure.ai.openai.models.AudioTranscriptionTimestampGranularity
-
Deprecated.Use the
AudioTranscriptionTimestampGranularity.fromString(String)factory method. - AudioTranscriptionWord - Class in com.azure.ai.openai.models
-
Extended information about a single transcribed word, as provided on responses when the 'word' timestamp granularity is provided.
- AudioTranslation - Class in com.azure.ai.openai.models
-
Result information for an operation that translated spoken audio into written text.
- Audio Translation - Search tag in Overview
- Section
- 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.
- Authentication - Search tag in Overview
- Section
- AUTO - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptionsRanker
-
Enum value auto.
- AUTO - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
-
Enum value auto.
- AUTO - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
-
Enum value auto.
- AUTO - Enum constant in enum com.azure.ai.openai.responses.models.ResponseTruncation
-
Enum value auto.
- 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.
- AUTO - Static variable in class com.azure.ai.openai.models.ServiceTierOptions
-
Service tier option for auto.
- AZURE_COSMOS_DB - Static variable in class com.azure.ai.openai.models.AzureChatExtensionType
-
Represents the use of Azure Cosmos DB as an Azure OpenAI chat extension.
- AZURE_SEARCH - Static variable in class com.azure.ai.openai.models.AzureChatExtensionType
-
Represents the use of Azure AI Search as an Azure OpenAI chat extension.
- 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.
- AzureChatExtensionRetrievedDocument - Class in com.azure.ai.openai.models
-
The retrieved document.
- AzureChatExtensionRetrieveDocumentFilterReason - Enum in com.azure.ai.openai.models
-
The reason for filtering the retrieved document.
- 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.
- AzureChatExtensionType - Class in com.azure.ai.openai.models
-
A representation of configuration data for a single Azure OpenAI chat extension.
- AzureChatExtensionType() - Constructor for class com.azure.ai.openai.models.AzureChatExtensionType
-
Deprecated.Use the
AzureChatExtensionType.fromString(String)factory method. - 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.
- Azure OpenAI client library for Java - Search tag in Overview
- Section
- AzureResponsesServiceVersion - Enum in com.azure.ai.openai.responses
-
Service version of AzureResponsesClient.
- 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
- BACK - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Enum value back.
- BASE64 - Static variable in class com.azure.ai.openai.models.ImageGenerationResponseFormat
-
Image generation response items should provide image data as a base64-encoded string.
- Batch - Class in com.azure.ai.openai.models
-
The Batch object.
- BATCH - Static variable in class com.azure.ai.openai.models.CreateUploadRequestPurpose
-
Static value batch for CreateUploadRequestPurpose.
- BATCH - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used as input to .
- BATCH - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value batch for UploadPurpose.
- BATCH_OUTPUT - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used as output by a vector store batch operation.
- BATCH_OUTPUT - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value batch_output for UploadPurpose.
- BatchCreateRequest - Class in com.azure.ai.openai.models
-
Defines the request to create a batch.
- BatchCreateRequest(String, String, String) - Constructor for class com.azure.ai.openai.models.BatchCreateRequest
-
Creates an instance of BatchCreateRequest class.
- BatchErrorDatum - Class in com.azure.ai.openai.models
-
A Datum containing information about a Batch Error.
- BatchErrorList - Class in com.azure.ai.openai.models
-
A list of Batch errors.
- Batch operations - Search tag in Overview
- Section
- BatchRequestCounts - Class in com.azure.ai.openai.models
-
The BatchRequestCounts model.
- BatchStatus - Class in com.azure.ai.openai.models
-
The status of a batch.
- BatchStatus() - Constructor for class com.azure.ai.openai.models.BatchStatus
-
Deprecated.Use the
BatchStatus.fromString(String)factory method. - BROWSER - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Enum value browser.
- buildAsyncClient() - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
Builds an instance of OpenAIAsyncClient class.
- buildAsyncClient() - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
Builds an instance of ResponsesAsyncClient class.
- buildClient() - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
Builds an instance of OpenAIClient class.
- buildClient() - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
Builds an instance of ResponsesClient class.
C
- cancelBatch(String) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets details for a single batch specified by the given batchID.
- cancelBatch(String) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets details for a single batch specified by the given batchID.
- cancelBatchWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets details for a single batch specified by the given batchID.
- cancelBatchWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets details for a single batch specified by the given batchID.
- CANCELLED - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The batch was cancelled.
- CANCELLED - Static variable in class com.azure.ai.openai.models.UploadStatus
-
Static value cancelled for UploadStatus.
- CANCELLING - Static variable in class com.azure.ai.openai.models.BatchStatus
-
Cancellation of the batch has been initiated.
- cancelUpload(String) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Cancels the Upload.
- cancelUpload(String) - Method in class com.azure.ai.openai.OpenAIClient
-
Cancels the Upload.
- cancelUploadWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Cancels the Upload.
- cancelUploadWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Cancels the Upload.
- 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'.
- ChatCompletionModality - Class in com.azure.ai.openai.models
-
Values to specified the required modality for the model to use.
- ChatCompletionModality() - Constructor for class com.azure.ai.openai.models.ChatCompletionModality
-
Deprecated.Use the
ChatCompletionModality.fromString(String)factory method. - ChatCompletions - Class in com.azure.ai.openai.models
-
Representation of the response data from a chat completions request.
- Chat completions - Search tag in Overview
- Section
- 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(ChatCompletionsFunctionToolDefinitionFunction) - Constructor for class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition
-
Creates an instance of ChatCompletionsFunctionToolDefinition class.
- ChatCompletionsFunctionToolDefinitionFunction - Class in com.azure.ai.openai.models
-
The ChatCompletionsFunctionToolDefinitionFunction model.
- ChatCompletionsFunctionToolDefinitionFunction(String) - Constructor for class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
-
Creates an instance of ChatCompletionsFunctionToolDefinitionFunction 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.
- ChatCompletionsJsonSchemaResponseFormat - Class in com.azure.ai.openai.models
-
A response format for Chat Completions that restricts responses to emitting JSON that conforms to a provided JSON Schema for Structured Outputs.
- ChatCompletionsJsonSchemaResponseFormat(ChatCompletionsJsonSchemaResponseFormatJsonSchema) - Constructor for class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormat
-
Creates an instance of ChatCompletionsJsonSchemaResponseFormat class.
- ChatCompletionsJsonSchemaResponseFormatJsonSchema - Class in com.azure.ai.openai.models
-
The ChatCompletionsJsonSchemaResponseFormatJsonSchema model.
- ChatCompletionsJsonSchemaResponseFormatJsonSchema(String) - Constructor for class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Creates an instance of ChatCompletionsJsonSchemaResponseFormatJsonSchema 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) - 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.
- ChatCompletionsToolSelection - Class in com.azure.ai.openai.models
-
Represents the tool selection for chat completions.
- ChatCompletionsToolSelection(ChatCompletionsNamedToolSelection) - Constructor for class com.azure.ai.openai.models.ChatCompletionsToolSelection
-
Creates a
ChatCompletionsToolSelectionwith the provided named tool selection. - ChatCompletionsToolSelection(ChatCompletionsToolSelectionPreset) - Constructor for class com.azure.ai.openai.models.ChatCompletionsToolSelection
-
Creates a
ChatCompletionsToolSelectionwith the provided preset. - 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. - ChatCompletionStreamOptions - Class in com.azure.ai.openai.models
-
Options for streaming response.
- ChatCompletionStreamOptions() - Constructor for class com.azure.ai.openai.models.ChatCompletionStreamOptions
-
Creates an instance of ChatCompletionStreamOptions class.
- 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.
- CHATGPT_4O_LATEST - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value chatgpt-4o-latest for CreateResponsesRequestModel.
- ChatMessageAudioContentItem - Class in com.azure.ai.openai.models
-
A structured chat content item containing audio data.
- ChatMessageAudioContentItem(InputAudioContent) - Constructor for class com.azure.ai.openai.models.ChatMessageAudioContentItem
-
Creates an instance of ChatMessageAudioContentItem 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.
- ChatMessageRefusalContentItem - Class in com.azure.ai.openai.models
-
A structured chat content item containing model refusal information for a structured outputs request.
- ChatMessageRefusalContentItem(String) - Constructor for class com.azure.ai.openai.models.ChatMessageRefusalContentItem
-
Creates an instance of ChatMessageRefusalContentItem 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(ChatMessageContentItem[]) - Constructor for class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Creates a new instance of ChatRequestAssistantMessage using a collection of structured content.
- ChatRequestAssistantMessage(String) - Constructor for class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Creates an instance of ChatRequestAssistantMessage class.
- ChatRequestAssistantMessage(List<ChatMessageContentItem>) - Constructor for class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Creates an instance of ChatRequestAssistantMessage class.
- ChatRequestDeveloperMessage - Class in com.azure.ai.openai.models
-
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
- ChatRequestDeveloperMessage(ChatMessageContentItem[]) - Constructor for class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Creates a new instance of ChatRequestDeveloperMessage using a collection of structured content.
- ChatRequestDeveloperMessage(String) - Constructor for class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Creates an instance of ChatRequestDeveloperMessage class.
- ChatRequestDeveloperMessage(List<ChatMessageContentItem>) - Constructor for class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Creates an instance of ChatRequestDeveloperMessage 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(ChatMessageContentItem[]) - Constructor for class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Creates a new instance of ChatRequestSystemMessage using a collection of structured content.
- ChatRequestSystemMessage(String) - Constructor for class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Creates an instance of ChatRequestSystemMessage class.
- ChatRequestSystemMessage(List<ChatMessageContentItem>) - 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(ChatMessageContentItem[], String) - Constructor for class com.azure.ai.openai.models.ChatRequestToolMessage
-
Creates an instance of ChatRequestToolMessage class.
- ChatRequestToolMessage(String, String) - Constructor for class com.azure.ai.openai.models.ChatRequestToolMessage
-
Creates an instance of ChatRequestToolMessage class.
- ChatRequestToolMessage(List<ChatMessageContentItem>, 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.
- CITATIONS - Static variable in class com.azure.ai.openai.models.OnYourDataContextProperty
-
The `citations` property.
- CLICK - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value click.
- clientOptions(ClientOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- clientOptions(ClientOptions) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- 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.
- com.azure.ai.openai.responses - package com.azure.ai.openai.responses
-
Package containing the classes for AzureResponses.
- com.azure.ai.openai.responses.models - package com.azure.ai.openai.responses.models
-
Package containing the data models for AzureResponses.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Enum value completed.
- COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Enum value completed.
- COMPLETED - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The batch has been completed and the results are ready.
- COMPLETED - Static variable in class com.azure.ai.openai.models.UploadStatus
-
Static value completed for UploadStatus.
- completeUpload(String, CompleteUploadRequest) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Completes the Upload.
- completeUpload(String, CompleteUploadRequest) - Method in class com.azure.ai.openai.OpenAIClient
-
Completes the Upload.
- CompleteUploadRequest - Class in com.azure.ai.openai.models
-
The request body of an upload completion request.
- CompleteUploadRequest(List<String>) - Constructor for class com.azure.ai.openai.models.CompleteUploadRequest
-
Creates an instance of CompleteUploadRequest class.
- completeUploadWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Completes the Upload.
- completeUploadWithResponse(String, BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Completes the Upload.
- 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.
- CompletionsUsageCompletionTokensDetails - Class in com.azure.ai.openai.models
-
The CompletionsUsageCompletionTokensDetails model.
- CompletionsUsagePromptTokensDetails - Class in com.azure.ai.openai.models
-
The CompletionsUsagePromptTokensDetails model.
- COMPUTER - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Enum value computer_use_preview.
- COMPUTER - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Enum value computer_use_preview.
- COMPUTER_CALL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value computer_call.
- COMPUTER_CALL_OUTPUT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value computer_call_output.
- COMPUTER_CALL_OUTPUT_OUTPUT_IMAGE_URL - Enum constant in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
-
Enum value computer_call_output.output.image_url.
- COMPUTER_SCREENSHOT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutputType
-
Enum value computer_screenshot.
- COMPUTER_USE_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value computer-use-preview for CreateResponsesRequestModel.
- COMPUTER_USE_PREVIEW_2025_02_04 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value computer-use-preview-2025-02-04 for CreateResponsesRequestModel.
- COMPUTER_USE_PREVIEW_2025_03_11 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value computer-use-preview-2025-03-11 for CreateResponsesRequestModel.
- CONCISE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationGenerateSummary
-
Enum value concise.
- configuration(Configuration) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- configuration(Configuration) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- CONNECTION_STRING - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via connection string.
- CONTENT - Static variable in class com.azure.ai.openai.models.PredictionContentType
-
Predicted content is of type content.
- CONTENT_FILTER - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetailsReason
-
Enum value content_filter.
- 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.
- ContentFilterCompletionTextSpan - Class in com.azure.ai.openai.models
-
Describes a span within generated completion text.
- ContentFilterCompletionTextSpanResult - Class in com.azure.ai.openai.models
-
Describes a span within generated completion text.
- ContentFilterDetailedResults - Class in com.azure.ai.openai.models
-
Represents a structured collection of result details for 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. - Contributing - Search tag in Overview
- Section
- Create a client with proxy options - Search tag in Overview
- Section
- Create an Azure OpenAI client with Azure Entra ID credential - Search tag in Overview
- Section
- Create an Azure OpenAI client with key credential - Search tag in Overview
- Section
- createBatch(BatchCreateRequest) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Creates and executes a batch from an uploaded file of requests.
- createBatch(BatchCreateRequest) - Method in class com.azure.ai.openai.OpenAIClient
-
Creates and executes a batch from an uploaded file of requests.
- createBatchWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Creates and executes a batch from an uploaded file of requests.
- createBatchWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Creates and executes a batch from an uploaded file of requests.
- createResponse(CreateResponsesRequest) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Creates a model response.
- createResponse(CreateResponsesRequest) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Creates a model response.
- createResponse(CreateResponsesRequest, RequestOptions) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Creates a model response.
- createResponse(CreateResponsesRequest, RequestOptions) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Creates a model response.
- CreateResponseRequestAccept - Enum in com.azure.ai.openai.responses.models
-
Defines values for CreateResponseRequestAccept.
- CreateResponsesRequest - Class in com.azure.ai.openai.responses.models
-
The CreateResponsesRequest model.
- CreateResponsesRequest(CreateResponsesRequestModel, String) - Constructor for class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Creates an instance of CreateResponsesRequest class.
- CreateResponsesRequest(CreateResponsesRequestModel, List<ResponsesMessage>) - Constructor for class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Creates an instance of CreateResponsesRequest class.
- CreateResponsesRequestIncludable - Enum in com.azure.ai.openai.responses.models
-
Defines values for CreateResponsesRequestIncludable.
- CreateResponsesRequestModel - Class in com.azure.ai.openai.responses.models
-
Defines values for CreateResponsesRequestModel.
- CreateResponsesRequestModel() - Constructor for class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Deprecated.Use the
CreateResponsesRequestModel.fromString(String)factory method. - createResponseStream(CreateResponsesRequest) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Creates a model response.
- createResponseStream(CreateResponsesRequest, RequestOptions) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Creates a model response.
- createResponseStreaming(CreateResponsesRequest) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Creates a model response.
- createResponseStreaming(CreateResponsesRequest, RequestOptions) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Creates a model response.
- createUpload(CreateUploadRequest) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Creates an intermediate Upload object that you can add Parts to.
- createUpload(CreateUploadRequest) - Method in class com.azure.ai.openai.OpenAIClient
-
Creates an intermediate Upload object that you can add Parts to.
- CreateUploadRequest - Class in com.azure.ai.openai.models
-
The request body of an upload creation operation.
- CreateUploadRequest(String, CreateUploadRequestPurpose, int, String) - Constructor for class com.azure.ai.openai.models.CreateUploadRequest
-
Creates an instance of CreateUploadRequest class.
- CreateUploadRequestPurpose - Class in com.azure.ai.openai.models
-
Defines values for CreateUploadRequestPurpose.
- CreateUploadRequestPurpose() - Constructor for class com.azure.ai.openai.models.CreateUploadRequestPurpose
-
Deprecated.Use the
CreateUploadRequestPurpose.fromString(String)factory method. - createUploadWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Creates an intermediate Upload object that you can add Parts to.
- createUploadWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Creates an intermediate Upload object that you can add Parts to.
- credential(KeyCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- credential(KeyCredential) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- credential(TokenCredential) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- credential(TokenCredential) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
D
- DataFileDetails - Class in com.azure.ai.openai.models
-
The file details for the "data" field.
- DataFileDetails(BinaryData) - Constructor for class com.azure.ai.openai.models.DataFileDetails
-
Creates an instance of DataFileDetails class.
- DEFAULT - Static variable in class com.azure.ai.openai.models.ServiceTier
-
Service tier option for default.
- DEFAULT - Static variable in class com.azure.ai.openai.models.ServiceTierOptions
-
Service tier option for default.
- DEFAULT_2024_11_15 - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptionsRanker
-
Enum value default-2024-11-15.
- Default HTTP Client - Search tag in Overview
- Section
- Default SSL library - Search tag in Overview
- Section
- DELETED - Static variable in class com.azure.ai.openai.models.FileState
-
The entity has been deleted but may still be referenced by other entities predating the deletion.
- deleteFile(String) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Delete a previously uploaded file.
- deleteFile(String) - Method in class com.azure.ai.openai.OpenAIClient
-
Delete a previously uploaded file.
- deleteFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Delete a previously uploaded file.
- deleteFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Delete a previously uploaded file.
- deleteResponse(String) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Deletes a response by ID.
- deleteResponse(String) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Deletes a response by ID.
- deleteResponse(String, RequestOptions) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Deletes a response by ID.
- deleteResponse(String, RequestOptions) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Deletes a response by ID.
- DeleteResponseResponse - Class in com.azure.ai.openai.responses.models
-
The DeleteResponseResponse model.
- DELETING - Static variable in class com.azure.ai.openai.models.FileState
-
The entity is in the process to be deleted.
- DEPLOYMENT_NAME - Static variable in class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Represents an Ada model deployment name to use.
- DESC - Enum constant in enum com.azure.ai.openai.responses.models.ListInputItemsRequestOrder
-
Enum value desc.
- DETAILED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationGenerateSummary
-
Enum value detailed.
- DEVELOPER - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Enum value developer.
- DEVELOPER - Static variable in class com.azure.ai.openai.models.ChatRole
-
The role that provides instructions that the model should follow.
- DISABLED - Enum constant in enum com.azure.ai.openai.responses.models.ResponseTruncation
-
Enum value disabled.
- DOUBLE_CLICK - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value double_click.
- DRAG - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value drag.
E
- ECHO - Static variable in class com.azure.ai.openai.models.SpeechVoice
-
The Echo voice.
- ELASTICSEARCH - Static variable in class com.azure.ai.openai.models.AzureChatExtensionType
-
Represents the use of Elasticsearch® index as an Azure OpenAI chat extension.
- 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.
- Enable client logging - Search tag in Overview
- Section
- ENCODED_API_KEY - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via encoded API key.
- endpoint(String) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- endpoint(String) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- ENDPOINT - Static variable in class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Represents vectorization performed by public service calls to an Azure OpenAI embedding model.
- ERROR - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value error.
- ERROR - Static variable in class com.azure.ai.openai.models.FileState
-
The operation has completed processing with a failure and cannot be further consumed.
- Examples - Search tag in Overview
- Section
- EXPIRED - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The batch was not able to complete within the 24-hour time window.
- EXPIRED - Static variable in class com.azure.ai.openai.models.UploadStatus
-
Static value expired for UploadStatus.
F
- FABLE - Static variable in class com.azure.ai.openai.models.SpeechVoice
-
The Fable voice.
- FAILED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Enum value failed.
- FAILED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Enum value failed.
- FAILED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Enum value failed.
- FAILED - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The input file has failed the validation process.
- FILE_CITATION - Enum constant in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
-
Enum value file_citation.
- FILE_CITATION - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationType
-
Enum value file_citation.
- FILE_PATH - Enum constant in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
-
Enum value file_path.
- FILE_PATH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationType
-
Enum value file_path.
- FILE_SEARCH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Enum value file_search.
- FILE_SEARCH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Enum value file_search.
- FILE_SEARCH_CALL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value file_search_call.
- FILE_SEARCH_CALL_RESULTS - Enum constant in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
-
Enum value file_search_call.results.
- FileDeletionStatus - Class in com.azure.ai.openai.models
-
A status response from a file deletion operation.
- FileDetails - Class in com.azure.ai.openai.models
-
The file details for the "file" field.
- FileDetails(BinaryData, String) - Constructor for class com.azure.ai.openai.models.FileDetails
-
Creates an instance of FileDetails class.
- File operations - Search tag in Overview
- Section
- FilePurpose - Class in com.azure.ai.openai.models
-
The possible values denoting the intended usage of a file.
- FilePurpose() - Constructor for class com.azure.ai.openai.models.FilePurpose
-
Deprecated.Use the
FilePurpose.fromString(String)factory method. - FileState - Class in com.azure.ai.openai.models
-
The state of the file.
- FileState() - Constructor for class com.azure.ai.openai.models.FileState
-
Deprecated.Use the
FileState.fromString(String)factory method. - FINALIZING - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The batch has completed and the results are being prepared.
- FINE_TUNE - Static variable in class com.azure.ai.openai.models.CreateUploadRequestPurpose
-
Static value fine-tune for CreateUploadRequestPurpose.
- FINE_TUNE - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used for fine tuning input.
- FINE_TUNE - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value fine-tune for UploadPurpose.
- FINE_TUNE_RESULTS - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used for fine tuning results.
- FINE_TUNE_RESULTS - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value fine-tune-results for UploadPurpose.
- FLAC - Static variable in class com.azure.ai.openai.models.OutputAudioFormat
-
The output audio format is FLAC.
- FLAC - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat
-
Use FLAC as the audio output format.
- FORWARD - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Enum value forward,.
- fromBinaryData(BinaryData) - Static method in class com.azure.ai.openai.models.ChatCompletionsToolSelection
-
Converts a JSON string to a
ChatCompletionsToolSelection. - fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioOutputParameters
-
Reads an instance of AudioOutputParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioResponseData
-
Reads an instance of AudioResponseData from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioTranscription
-
Reads an instance of AudioTranscription from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioTranscriptionSegment
-
Reads an instance of AudioTranscriptionSegment from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioTranscriptionWord
-
Reads an instance of AudioTranscriptionWord from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioTranslation
-
Reads an instance of AudioTranslation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AudioTranslationSegment
-
Reads an instance of AudioTranslationSegment from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatEnhancementConfiguration
-
Reads an instance of AzureChatEnhancementConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatEnhancements
-
Reads an instance of AzureChatEnhancements from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatExtensionConfiguration
-
Reads an instance of AzureChatExtensionConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation
-
Reads an instance of AzureChatExtensionDataSourceResponseCitation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Reads an instance of AzureChatExtensionRetrievedDocument from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatExtensionsMessageContext
-
Reads an instance of AzureChatExtensionsMessageContext from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatGroundingEnhancementConfiguration
-
Reads an instance of AzureChatGroundingEnhancementConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureChatOCREnhancementConfiguration
-
Reads an instance of AzureChatOCREnhancementConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionConfiguration
-
Reads an instance of AzureCosmosDBChatExtensionConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Reads an instance of AzureCosmosDBChatExtensionParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions
-
Reads an instance of AzureCosmosDBFieldMappingOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureGroundingEnhancement
-
Reads an instance of AzureGroundingEnhancement from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureGroundingEnhancementCoordinatePoint
-
Reads an instance of AzureGroundingEnhancementCoordinatePoint from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureGroundingEnhancementLine
-
Reads an instance of AzureGroundingEnhancementLine from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureGroundingEnhancementLineSpan
-
Reads an instance of AzureGroundingEnhancementLineSpan from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureSearchChatExtensionConfiguration
-
Reads an instance of AzureSearchChatExtensionConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Reads an instance of AzureSearchChatExtensionParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions
-
Reads an instance of AzureSearchIndexFieldMappingOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.Batch
-
Reads an instance of Batch from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.BatchCreateRequest
-
Reads an instance of BatchCreateRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.BatchErrorDatum
-
Reads an instance of BatchErrorDatum from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.BatchErrorList
-
Reads an instance of BatchErrorList from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.BatchRequestCounts
-
Reads an instance of BatchRequestCounts from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatChoice
-
Reads an instance of ChatChoice from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatChoiceLogProbabilityInfo
-
Reads an instance of ChatChoiceLogProbabilityInfo from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletions
-
Reads an instance of ChatCompletions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolCall
-
Reads an instance of ChatCompletionsFunctionToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition
-
Reads an instance of ChatCompletionsFunctionToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
-
Reads an instance of ChatCompletionsFunctionToolDefinitionFunction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolSelection
-
Reads an instance of ChatCompletionsFunctionToolSelection from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsJsonResponseFormat
-
Reads an instance of ChatCompletionsJsonResponseFormat from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormat
-
Reads an instance of ChatCompletionsJsonSchemaResponseFormat from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Reads an instance of ChatCompletionsJsonSchemaResponseFormatJsonSchema from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsNamedFunctionToolSelection
-
Reads an instance of ChatCompletionsNamedFunctionToolSelection from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsNamedToolSelection
-
Reads an instance of ChatCompletionsNamedToolSelection from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Reads an instance of ChatCompletionsOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsResponseFormat
-
Reads an instance of ChatCompletionsResponseFormat from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsTextResponseFormat
-
Reads an instance of ChatCompletionsTextResponseFormat from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsToolCall
-
Reads an instance of ChatCompletionsToolCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionsToolDefinition
-
Reads an instance of ChatCompletionsToolDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatCompletionStreamOptions
-
Reads an instance of ChatCompletionStreamOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatFinishDetails
-
Reads an instance of ChatFinishDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatMessageAudioContentItem
-
Reads an instance of ChatMessageAudioContentItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatMessageContentItem
-
Reads an instance of ChatMessageContentItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatMessageImageContentItem
-
Reads an instance of ChatMessageImageContentItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatMessageImageUrl
-
Reads an instance of ChatMessageImageUrl from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatMessageRefusalContentItem
-
Reads an instance of ChatMessageRefusalContentItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatMessageTextContentItem
-
Reads an instance of ChatMessageTextContentItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Reads an instance of ChatRequestAssistantMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Reads an instance of ChatRequestDeveloperMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestFunctionMessage
-
Reads an instance of ChatRequestFunctionMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestMessage
-
Reads an instance of ChatRequestMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Reads an instance of ChatRequestSystemMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestToolMessage
-
Reads an instance of ChatRequestToolMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatRequestUserMessage
-
Reads an instance of ChatRequestUserMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatResponseMessage
-
Reads an instance of ChatResponseMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatTokenLogProbabilityInfo
-
Reads an instance of ChatTokenLogProbabilityInfo from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ChatTokenLogProbabilityResult
-
Reads an instance of ChatTokenLogProbabilityResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.Choice
-
Reads an instance of Choice from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CompleteUploadRequest
-
Reads an instance of CompleteUploadRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.Completions
-
Reads an instance of Completions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel
-
Reads an instance of CompletionsLogProbabilityModel from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CompletionsOptions
-
Reads an instance of CompletionsOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CompletionsUsage
-
Reads an instance of CompletionsUsage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails
-
Reads an instance of CompletionsUsageCompletionTokensDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CompletionsUsagePromptTokensDetails
-
Reads an instance of CompletionsUsagePromptTokensDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterBlocklistIdResult
-
Reads an instance of ContentFilterBlocklistIdResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterCitedDetectionResult
-
Reads an instance of ContentFilterCitedDetectionResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpan
-
Reads an instance of ContentFilterCompletionTextSpan from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpanResult
-
Reads an instance of ContentFilterCompletionTextSpanResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterDetailedResults
-
Reads an instance of ContentFilterDetailedResults from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterDetectionResult
-
Reads an instance of ContentFilterDetectionResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterResult
-
Reads an instance of ContentFilterResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt
-
Reads an instance of ContentFilterResultDetailsForPrompt from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterResultsForChoice
-
Reads an instance of ContentFilterResultsForChoice from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ContentFilterResultsForPrompt
-
Reads an instance of ContentFilterResultsForPrompt from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.CreateUploadRequest
-
Reads an instance of CreateUploadRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ElasticsearchChatExtensionConfiguration
-
Reads an instance of ElasticsearchChatExtensionConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Reads an instance of ElasticsearchChatExtensionParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions
-
Reads an instance of ElasticsearchIndexFieldMappingOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.EmbeddingItem
-
Reads an instance of EmbeddingItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.Embeddings
-
Reads an instance of Embeddings from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.EmbeddingsOptions
-
Reads an instance of EmbeddingsOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.EmbeddingsUsage
-
Reads an instance of EmbeddingsUsage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.FileDeletionStatus
-
Reads an instance of FileDeletionStatus from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.FunctionCall
-
Reads an instance of FunctionCall from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.FunctionDefinition
-
Reads an instance of FunctionDefinition from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.FunctionName
-
Reads an instance of FunctionName from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ImageGenerationContentFilterResults
-
Reads an instance of ImageGenerationContentFilterResults from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ImageGenerationData
-
Reads an instance of ImageGenerationData from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ImageGenerationOptions
-
Reads an instance of ImageGenerationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults
-
Reads an instance of ImageGenerationPromptFilterResults from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.ImageGenerations
-
Reads an instance of ImageGenerations from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.InputAudioContent
-
Reads an instance of InputAudioContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.MaxTokensFinishDetails
-
Reads an instance of MaxTokensFinishDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.MongoDBChatExtensionConfiguration
-
Reads an instance of MongoDBChatExtensionConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Reads an instance of MongoDBChatExtensionParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.MongoDBChatExtensionParametersFieldsMapping
-
Reads an instance of MongoDBChatExtensionParametersFieldsMapping from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions
-
Reads an instance of OnYourDataAccessTokenAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataApiKeyAuthenticationOptions
-
Reads an instance of OnYourDataApiKeyAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataAuthenticationOptions
-
Reads an instance of OnYourDataAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataConnectionStringAuthenticationOptions
-
Reads an instance of OnYourDataConnectionStringAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource
-
Reads an instance of OnYourDataDeploymentNameVectorizationSource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataEncodedApiKeyAuthenticationOptions
-
Reads an instance of OnYourDataEncodedApiKeyAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource
-
Reads an instance of OnYourDataEndpointVectorizationSource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataIntegratedVectorizationSource
-
Reads an instance of OnYourDataIntegratedVectorizationSource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions
-
Reads an instance of OnYourDataKeyAndKeyIdAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataModelIdVectorizationSource
-
Reads an instance of OnYourDataModelIdVectorizationSource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataSystemAssignedManagedIdentityAuthenticationOptions
-
Reads an instance of OnYourDataSystemAssignedManagedIdentityAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataUserAssignedManagedIdentityAuthenticationOptions
-
Reads an instance of OnYourDataUserAssignedManagedIdentityAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataUsernameAndPasswordAuthenticationOptions
-
Reads an instance of OnYourDataUsernameAndPasswordAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataVectorizationSource
-
Reads an instance of OnYourDataVectorizationSource from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataVectorSearchAccessTokenAuthenticationOptions
-
Reads an instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataVectorSearchApiKeyAuthenticationOptions
-
Reads an instance of OnYourDataVectorSearchApiKeyAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions
-
Reads an instance of OnYourDataVectorSearchAuthenticationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.OpenAIFile
-
Reads an instance of OpenAIFile from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.PineconeChatExtensionConfiguration
-
Reads an instance of PineconeChatExtensionConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Reads an instance of PineconeChatExtensionParameters from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.PineconeFieldMappingOptions
-
Reads an instance of PineconeFieldMappingOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.PredictionContent
-
Reads an instance of PredictionContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.SpeechGenerationOptions
-
Reads an instance of SpeechGenerationOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.StopFinishDetails
-
Reads an instance of StopFinishDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.Upload
-
Reads an instance of Upload from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.UploadPart
-
Reads an instance of UploadPart from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.models.UserSecurityContext
-
Reads an instance of UserSecurityContext from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Reads an instance of CreateResponsesRequest from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.DeleteResponseResponse
-
Reads an instance of DeleteResponseResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesAssistantMessage
-
Reads an instance of ResponsesAssistantMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
-
Reads an instance of ResponsesComputerCallClickAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDoubleClickAction
-
Reads an instance of ResponsesComputerCallDoubleClickAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragAction
-
Reads an instance of ResponsesComputerCallDragAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragActionPath
-
Reads an instance of ResponsesComputerCallDragActionPath from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Reads an instance of ResponsesComputerCallItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemAction
-
Reads an instance of ResponsesComputerCallItemAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemSafetyCheck
-
Reads an instance of ResponsesComputerCallItemSafetyCheck from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallKeyPressAction
-
Reads an instance of ResponsesComputerCallKeyPressAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallMoveAction
-
Reads an instance of ResponsesComputerCallMoveAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Reads an instance of ResponsesComputerCallOutputItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutput
-
Reads an instance of ResponsesComputerCallOutputItemOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Reads an instance of ResponsesComputerCallOutputItemScreenshot from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScreenshotAction
-
Reads an instance of ResponsesComputerCallScreenshotAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Reads an instance of ResponsesComputerCallScrollAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallTypeAction
-
Reads an instance of ResponsesComputerCallTypeAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerCallWaitAction
-
Reads an instance of ResponsesComputerCallWaitAction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesComputerTool
-
Reads an instance of ResponsesComputerTool from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesContent
-
Reads an instance of ResponsesContent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesDeveloperMessage
-
Reads an instance of ResponsesDeveloperMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesError
-
Reads an instance of ResponsesError from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
-
Reads an instance of ResponsesFileSearchCallItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Reads an instance of ResponsesFileSearchCallItemResult from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Reads an instance of ResponsesFileSearchTool from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
-
Reads an instance of ResponsesFileSearchToolRankingOptions from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Reads an instance of ResponsesFunctionCallItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
-
Reads an instance of ResponsesFunctionCallOutput from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Reads an instance of ResponsesFunctionTool from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Reads an instance of ResponsesInputContentFile from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Reads an instance of ResponsesInputContentImage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesInputContentText
-
Reads an instance of ResponsesInputContentText from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
-
Reads an instance of ResponsesInputItemList from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesItem
-
Reads an instance of ResponsesItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesItemReferenceItem
-
Reads an instance of ResponsesItemReferenceItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesMessage
-
Reads an instance of ResponsesMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesOutputContentRefusal
-
Reads an instance of ResponsesOutputContentRefusal from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesOutputContentText
-
Reads an instance of ResponsesOutputContentText from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotation
-
Reads an instance of ResponsesOutputTextAnnotation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFileCitation
-
Reads an instance of ResponsesOutputTextAnnotationFileCitation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath
-
Reads an instance of ResponsesOutputTextAnnotationFilePath from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Reads an instance of ResponsesOutputTextAnnotationUrlCitation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesReasoningConfiguration
-
Reads an instance of ResponsesReasoningConfiguration from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesReasoningItem
-
Reads an instance of ResponsesReasoningItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElement
-
Reads an instance of ResponsesReasoningItemSummaryElement from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElementSummaryText
-
Reads an instance of ResponsesReasoningItemSummaryElementSummaryText from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Reads an instance of ResponsesResponse from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetails
-
Reads an instance of ResponsesResponseIncompleteDetails1 from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallCompleted
-
Reads an instance of ResponsesResponseStreamEventResponseWebSearchCallCompleted from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallInProgress
-
Reads an instance of ResponsesResponseStreamEventResponseWebSearchCallInProgress from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallSearching
-
Reads an instance of ResponsesResponseStreamEventResponseWebSearchCallSearching from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponseUsage
-
Reads an instance of ResponsesResponseUsage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesResponseUsageOutputTokensDetails
-
Reads an instance of ResponsesResponseUsageOutputTokensDetails from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEvent
-
Reads an instance of ResponsesStreamEvent from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCompleted
-
Reads an instance of ResponsesStreamEventCompleted from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
-
Reads an instance of ResponsesStreamEventContentPartAdded from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
-
Reads an instance of ResponsesStreamEventContentPartDone from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCreated
-
Reads an instance of ResponsesStreamEventCreated from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventError
-
Reads an instance of ResponsesStreamEventError from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFailed
-
Reads an instance of ResponsesStreamEventFailed from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallCompleted
-
Reads an instance of ResponsesStreamEventFileSearchCallCompleted from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallInProgress
-
Reads an instance of ResponsesStreamEventFileSearchCallInProgress from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallSearching
-
Reads an instance of ResponsesStreamEventFileSearchCallSearching from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDelta
-
Reads an instance of ResponsesStreamEventFunctionCallArgumentsDelta from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDone
-
Reads an instance of ResponsesStreamEventFunctionCallArgumentsDone from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventIncomplete
-
Reads an instance of ResponsesStreamEventIncomplete from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventInProgress
-
Reads an instance of ResponsesStreamEventInProgress from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemAdded
-
Reads an instance of ResponsesStreamEventOutputItemAdded from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemDone
-
Reads an instance of ResponsesStreamEventOutputItemDone from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
-
Reads an instance of ResponsesStreamEventOutputTextAnnotationAdded from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
-
Reads an instance of ResponsesStreamEventOutputTextDelta from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
-
Reads an instance of ResponsesStreamEventOutputTextDone from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
-
Reads an instance of ResponsesStreamEventRefusalDelta from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
-
Reads an instance of ResponsesStreamEventRefusalDone from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesSystemMessage
-
Reads an instance of ResponsesSystemMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesTextFormat
-
Reads an instance of ResponsesTextFormat from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonObject
-
Reads an instance of ResponsesTextFormatJsonObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Reads an instance of ResponsesTextFormatJsonSchema from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesTextFormatText
-
Reads an instance of ResponsesTextFormatText from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesTool
-
Reads an instance of ResponsesTool from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObject
-
Reads an instance of ResponsesToolChoiceObject from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectComputer
-
Reads an instance of ResponsesToolChoiceObjectComputer from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFileSearch
-
Reads an instance of ResponsesToolChoiceObjectFileSearch from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFunction
-
Reads an instance of ResponsesToolChoiceObjectFunction from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectWebSearch
-
Reads an instance of ResponsesToolChoiceObjectWebSearch from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesUserMessage
-
Reads an instance of ResponsesUserMessage from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Reads an instance of ResponsesWebSearchApproximateLocation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesWebSearchCallItem
-
Reads an instance of ResponsesWebSearchCallItem from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesWebSearchLocation
-
Reads an instance of ResponsesWebSearchLocation from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Reads an instance of ResponsesWebSearchTool from the JsonReader.
- fromJson(JsonReader) - Static method in class com.azure.ai.openai.responses.models.ResponseTextOptions
-
Reads an instance of ResponseTextOptions from the JsonReader.
- 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.AudioTranscriptionTimestampGranularity
-
Creates or finds a AudioTranscriptionTimestampGranularity 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 enum com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
-
Parses a serialized value to a AzureChatExtensionRetrieveDocumentFilterReason instance.
- fromString(String) - Static method in class com.azure.ai.openai.models.AzureChatExtensionType
-
Creates or finds a AzureChatExtensionType 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.BatchStatus
-
Creates or finds a BatchStatus from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.ChatCompletionModality
-
Creates or finds a ChatCompletionModality 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.CreateUploadRequestPurpose
-
Creates or finds a CreateUploadRequestPurpose 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.FilePurpose
-
Creates or finds a FilePurpose from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.FileState
-
Creates or finds a FileState 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.InputAudioFormat
-
Creates or finds a InputAudioFormat from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Creates or finds a OnYourDataAuthenticationType from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.OnYourDataContextProperty
-
Creates or finds a OnYourDataContextProperty from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Creates or finds a OnYourDataVectorizationSourceType from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationType
-
Creates or finds a OnYourDataVectorSearchAuthenticationType from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.OutputAudioFormat
-
Creates or finds a OutputAudioFormat from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.PredictionContentType
-
Creates or finds a PredictionContentType from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.ReasoningEffortValue
-
Creates or finds a ReasoningEffortValue from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.ServiceTier
-
Creates or finds a ServiceTier from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.ServiceTierOptions
-
Creates or finds a ServiceTierOptions 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.
- fromString(String) - Static method in enum com.azure.ai.openai.models.UploadObject
-
Parses a serialized value to a UploadObject instance.
- fromString(String) - Static method in class com.azure.ai.openai.models.UploadPurpose
-
Creates or finds a UploadPurpose from its string representation.
- fromString(String) - Static method in class com.azure.ai.openai.models.UploadStatus
-
Creates or finds a UploadStatus from its string representation.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.CreateResponseRequestAccept
-
Parses a serialized value to a CreateResponseRequestAccept instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
-
Parses a serialized value to a CreateResponsesRequestIncludable instance.
- fromString(String) - Static method in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Creates or finds a CreateResponsesRequestModel from its string representation.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ListInputItemsRequestOrder
-
Parses a serialized value to a ListInputItemsRequestOrder instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
-
Parses a serialized value to a ResponseOutputTextAnnotationType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Parses a serialized value to a ResponsesComputerCallActionType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Parses a serialized value to a ResponsesComputerCallClickButtonType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
-
Parses a serialized value to a ResponsesComputerCallItemStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutputType
-
Parses a serialized value to a ResponsesComputerCallOutputItemOutputType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
-
Parses a serialized value to a ResponsesComputerCallOutputItemStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Parses a serialized value to a ResponsesComputerToolEnvironment instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Parses a serialized value to a ResponsesContentType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Parses a serialized value to a ResponsesFileSearchCallItemStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptionsRanker
-
Parses a serialized value to a ResponsesFileSearchToolRankingOptionsRanker instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
-
Parses a serialized value to a ResponsesFunctionCallItemStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
-
Parses a serialized value to a ResponsesFunctionCallOutputStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
-
Parses a serialized value to a ResponsesInputContentImageDetail instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Parses a serialized value to a ResponsesItemType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Parses a serialized value to a ResponsesMessageRole instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
-
Parses a serialized value to a ResponsesMessageStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationType
-
Parses a serialized value to a ResponsesOutputTextAnnotationType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
-
Parses a serialized value to a ResponsesReasoningConfigurationEffort instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationGenerateSummary
-
Parses a serialized value to a ResponsesReasoningConfigurationGenerateSummary instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
-
Parses a serialized value to a ResponsesReasoningItemStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryType
-
Parses a serialized value to a ResponsesReasoningItemSummaryType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetailsReason
-
Parses a serialized value to a ResponsesResponseIncompleteDetailsReason instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Parses a serialized value to a ResponsesResponseStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Parses a serialized value to a ResponsesStreamEventType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
-
Parses a serialized value to a ResponsesTextFormatType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Parses a serialized value to a ResponsesToolChoiceObjectType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
-
Parses a serialized value to a ResponsesToolChoiceOption instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Parses a serialized value to a ResponsesToolType instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Parses a serialized value to a ResponsesWebSearchCallItemStatus instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
-
Parses a serialized value to a ResponsesWebSearchContextSize instance.
- fromString(String) - Static method in enum com.azure.ai.openai.responses.models.ResponseTruncation
-
Parses a serialized value to a ResponseTruncation instance.
- FUNCTION - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Enum value function.
- FUNCTION - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Enum value function.
- FUNCTION - Static variable in class com.azure.ai.openai.models.ChatRole
-
The role that provides function results for chat completions.
- FUNCTION_CALL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value function_call.
- FUNCTION_CALL - Static variable in class com.azure.ai.openai.models.CompletionsFinishReason
-
Completion ended normally, with the model requesting a function to be called.
- FUNCTION_CALL_OUTPUT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value function_call_output.
- 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.
- getAcceptedPredictionTokens() - Method in class com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails
-
Get the acceptedPredictionTokens property: When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.
- getAccessToken() - Method in class com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions
-
Get the accessToken property: The access token to use for authentication.
- getAccessToken() - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchAccessTokenAuthenticationOptions
-
Get the accessToken property: The access token to use for authentication.
- getAcknowledgedSafetyChecks() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Get the acknowledgedSafetyChecks property: The safety checks reported by the API that have been acknowledged by the developer.
- getAction() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Get the action property: The action property.
- getAllRetrievedDocuments() - Method in class com.azure.ai.openai.models.AzureChatExtensionsMessageContext
-
Get the allRetrievedDocuments property: All the retrieved documents.
- getAnnotation() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
-
Get the annotation property: The annotation index, within the output item content part, for the new annotation.The new annotation added.
- getAnnotations() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentText
-
Get the annotations property: The annotations property.
- getApplicationName() - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Get the applicationName property: The name of the application.
- getAppName() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Get the appName property: The app name for MongoDB.
- 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.
- getArguments() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Get the arguments property: The arguments property.
- getArguments() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDone
-
Get the arguments property: The final function call arguments as a complete JSON string.
- getArrayContent() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getArrayContent() - Method in class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getArrayContent() - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getArrayContent() - Method in class com.azure.ai.openai.models.ChatRequestToolMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getArrayContent() - 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.
- getAttributes() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Get the attributes property: The attributes property.
- getAudio() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the audio property: Parameters for audio output.
- getAudio() - Method in class com.azure.ai.openai.models.ChatResponseMessage
-
Get the audio property: If the audio output modality is requested, this object contains data about the audio response from the model.
- getAudioTokens() - Method in class com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails
-
Get the audioTokens property: Audio input tokens generated by the model.
- getAudioTokens() - Method in class com.azure.ai.openai.models.CompletionsUsagePromptTokensDetails
-
Get the audioTokens property: Audio input tokens present in the prompt.
- 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.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.MongoDBChatExtensionParameters
-
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.
- getAzureBlockId() - Method in class com.azure.ai.openai.models.UploadPart
-
Get the azureBlockId property: Azure only field.
- 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.
- getBatch(String) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets details for a single batch specified by the given batchID.
- getBatch(String) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets details for a single batch specified by the given batchID.
- getBatchWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets details for a single batch specified by the given batchID.
- getBatchWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets details for a single batch specified by the given batchID.
- 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.
- getButton() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
-
Get the button property: The button property.
- 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.
- getBytes() - Method in class com.azure.ai.openai.models.CreateUploadRequest
-
Get the bytes property: The number of bytes in the file you are uploading.
- getBytes() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the bytes property: The size of the file, in bytes.
- getBytes() - Method in class com.azure.ai.openai.models.Upload
-
Get the bytes property: The intended number of bytes to be uploaded.
- getCachedTokens() - Method in class com.azure.ai.openai.models.CompletionsUsagePromptTokensDetails
-
Get the cachedTokens property: Cached tokens present in the prompt.
- getCallId() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Get the callId property: An identifier used when responding to the tool call with output.
- getCallId() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Get the callId property: The ID of the computer tool call that produced the output.
- getCallId() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Get the callId property: The call_id property.
- getCallId() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
-
Get the callId property: The call_id property.
- getCancelledAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the cancelledAt property: The Unix timestamp (in seconds) for when the batch was cancelled.
- getCancellingAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the cancellingAt property: The Unix timestamp (in seconds) for when the batch started cancelling.
- 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.
- getChatCompletionsStream(String, ChatCompletionsOptions, ChatCompletionStreamOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets chat completions for the provided chat messages.
- getChatCompletionsStream(String, ChatCompletionsOptions, ChatCompletionStreamOptions) - 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.
- getChunkId() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
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.
- getCity() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Get the city property: Free text input for the city of the user, e.g.
- getCode() - Method in class com.azure.ai.openai.models.BatchErrorDatum
-
Get the code property: An error code identifying the error type.
- getCode() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemSafetyCheck
-
Get the code property: The code property.
- getCode() - Method in class com.azure.ai.openai.responses.models.ResponsesError
-
Get the code property: The code property.
- getCode() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventError
-
Get the code property: The error code, if applicable.
- getCollectionName() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Get the collectionName property: The collection name for MongoDB.
- getCompleted() - Method in class com.azure.ai.openai.models.BatchRequestCounts
-
Get the completed property: Number of requests that have been completed successfully.
- getCompletedAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the completedAt property: The Unix timestamp (in seconds) for when the batch was completed.
- getCompletionEndOffset() - Method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpan
-
Get the completionEndOffset property: Offset of the first UTF32 code point which is excluded from the span.
- 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.
- getCompletionsStream(String, CompletionsOptions, ChatCompletionStreamOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets completions as a stream for the provided input prompts.
- getCompletionsStream(String, CompletionsOptions, ChatCompletionStreamOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets completions as a stream for the provided input prompts.
- getCompletionStartOffset() - Method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpan
-
Get the completionStartOffset property: Offset of the UTF32 code point which begins the span.
- 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.
- getCompletionTokensDetails() - Method in class com.azure.ai.openai.models.CompletionsUsage
-
Get the completionTokensDetails property: Breakdown of tokens used in a completion.
- getCompletionWindow() - Method in class com.azure.ai.openai.models.Batch
-
Get the completionWindow property: The time frame within which the batch should be processed.
- getCompletionWindow() - Method in class com.azure.ai.openai.models.BatchCreateRequest
-
Get the completionWindow property: The time frame within which the batch should be processed.
- 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.AzureChatExtensionRetrievedDocument
-
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.ChatRequestDeveloperMessage
-
Get the content property: An array of content parts with a defined type.
- 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.
- getContent() - Method in class com.azure.ai.openai.models.DataFileDetails
-
Get the content property: The content of the file.
- getContent() - Method in class com.azure.ai.openai.models.FileDetails
-
Get the content property: The content of the file.
- getContent() - Method in class com.azure.ai.openai.models.PredictionContent
-
Get the content property: The content that should be matched when generating a model response.
- getContent() - Method in class com.azure.ai.openai.responses.models.ResponsesAssistantMessage
-
Get the content property: The content associated with the message.
- getContent() - Method in class com.azure.ai.openai.responses.models.ResponsesDeveloperMessage
-
Get the content property: The content associated with the message.
- getContent() - Method in class com.azure.ai.openai.responses.models.ResponsesSystemMessage
-
Get the content property: The content associated with the message.
- getContent() - Method in class com.azure.ai.openai.responses.models.ResponsesUserMessage
-
Get the content property: The content associated with 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.MongoDBChatExtensionParametersFieldsMapping
-
Get the contentFields property: The content_fields property.
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Get the contentFieldsSeparator property: The content_fields_separator property.
- 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.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
-
Get the contentIndex property: The index of the content part that was added to an item's content collection.
- getContentType() - Method in class com.azure.ai.openai.models.DataFileDetails
-
Get the contentType property: The content-type of the file.
- getContentType() - Method in class com.azure.ai.openai.models.FileDetails
-
Get the contentType property: The content-type of the file.
- 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.
- getCountry() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Get the country property: The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g.
- getCreatedAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the createdAt property: The Unix timestamp (in seconds) for when the batch was created.
- 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.
- getCreatedAt() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the createdAt property: The Unix timestamp, in seconds, representing when this object was created.
- getCreatedAt() - Method in class com.azure.ai.openai.models.Upload
-
Get the createdAt property: The Unix timestamp (in seconds) for when the Upload was created.
- getCreatedAt() - Method in class com.azure.ai.openai.models.UploadPart
-
Get the createdAt property: The Unix timestamp (in seconds) for when the Part was created.
- getCreatedAt() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the createdAt property: Unix timestamp (in seconds) of when this Response was created.
- 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.
- getCustomBlocklists() - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults
-
Get the customBlocklists property: Information about customer block lists and if something was detected the associated list ID.
- getData() - Method in class com.azure.ai.openai.models.AddUploadPartRequest
-
Get the data property: The chunk of bytes for this Part.
- getData() - Method in class com.azure.ai.openai.models.AudioResponseData
-
Get the data property: Base64 encoded audio bytes generated by the model, in the format specified in the request.
- getData() - Method in class com.azure.ai.openai.models.BatchErrorList
-
Get the data property: The list of Batch error data.
- 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.
- getData() - Method in class com.azure.ai.openai.models.InputAudioContent
-
Get the data property: Base64-encoded audio data.
- getData() - Method in class com.azure.ai.openai.models.PageableList
-
Get the data property: The requested list of items.
- getData() - Method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
-
Get the data property: The data property.
- 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.
- getDatabaseName() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Get the databaseName property: The database name for MongoDB.
- getDataSourceIndex() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Get the dataSourceIndex property: The index of the data source.
- 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.
- getDelta() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDelta
-
Get the delta property: The arguments delta as a partial JSON fragment.
- getDelta() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
-
Get the delta property: The text delta.
- getDelta() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
-
Get the delta property: The refusal delta.
- 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.ChatCompletionsFunctionToolDefinitionFunction
-
Get the description property: A description of what the function does, used by the model to choose when and how to call the function.
- getDescription() - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Get the description property: A description of what the response format is for, used by the model to determine how to respond in the format.
- getDescription() - Method in class com.azure.ai.openai.models.FunctionDefinition
-
Get the description property: A description of what the function does.
- getDescription() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Get the description property: The description property.
- getDescription() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Get the description property: The description property.
- 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.
- getDetail() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Get the detail property: The detail property.
- getDetails() - Method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpanResult
-
Get the details property: The collection of completion text spans.
- getDetails() - Method in class com.azure.ai.openai.models.ContentFilterDetailedResults
-
Get the details property: The collection of detailed blocklist result information.
- getDimensions() - Method in class com.azure.ai.openai.models.EmbeddingsOptions
-
Get the dimensions property: The number of dimensions the resulting output embeddings should have.
- getDimensions() - Method in class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource
-
Get the dimensions property: The number of dimensions the embeddings should have.
- getDisplayHeight() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerTool
-
Get the displayHeight property: The display_height property.
- getDisplayWidth() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerTool
-
Get the displayWidth property: The display_width property.
- 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.
- getEffort() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningConfiguration
-
Get the effort property: The effort property.
- 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.MongoDBChatExtensionParameters
-
Get the embeddingDependency property: The vectorization source to use with the MongoDB chat extension.
- 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.AudioTranscriptionWord
-
Get the end property: The end time of the word relative to the beginning of the audio, expressed in seconds.
- 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.
- getEndIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Get the endIndex property: The end_index property.
- 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.Batch
-
Get the endpoint property: The OpenAI API endpoint used by the batch.
- getEndpoint() - Method in class com.azure.ai.openai.models.BatchCreateRequest
-
Get the endpoint property: The API endpoint used by the batch.
- 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.MongoDBChatExtensionParameters
-
Get the endpoint property: The endpoint name for MongoDB.
- 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.
- getEndUserId() - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Get the endUserId property: This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application.
- getEndUserTenantId() - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Get the endUserTenantId property: The Microsoft 365 tenant ID the end user belongs to.
- 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.
- getEnvironment() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerTool
-
Get the environment property: The environment property.
- 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.
- getError() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the error property: The error property.
- getErrorFileId() - Method in class com.azure.ai.openai.models.Batch
-
Get the errorFileId property: The ID of the file containing the outputs of requests with errors.
- getErrors() - Method in class com.azure.ai.openai.models.Batch
-
Get the errors property: The list of Batch errors.
- getExpiredAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the expiredAt property: The Unix timestamp (in seconds) for when the batch expired.
- getExpiresAt() - Method in class com.azure.ai.openai.models.AudioResponseData
-
Get the expiresAt property: The Unix timestamp (in seconds) for when this audio response will no longer be accessible on the server for use in multi-turn conversations.
- getExpiresAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the expiresAt property: The Unix timestamp (in seconds) for when the batch will expire.
- getExpiresAt() - Method in class com.azure.ai.openai.models.Upload
-
Get the expiresAt property: The Unix timestamp (in seconds) for when the Upload was created.
- getFailed() - Method in class com.azure.ai.openai.models.BatchRequestCounts
-
Get the failed property: Number of requests that have failed.
- getFailedAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the failedAt property: The Unix timestamp (in seconds) for when the batch failed.
- 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.MongoDBChatExtensionParameters
-
Get the fieldsMapping property: Field mappings to apply to data used by the MongoDB data source.
- 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.
- getFile() - Method in class com.azure.ai.openai.models.Upload
-
Get the file property: The ready File object after the Upload is completed.
- getFile(String) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Returns information about a specific file.
- getFile(String) - Method in class com.azure.ai.openai.OpenAIClient
-
Returns information about a specific file.
- getFileContent(String) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Returns information about a specific file.
- getFileContent(String) - Method in class com.azure.ai.openai.OpenAIClient
-
Returns information about a specific file.
- getFileContentWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Returns information about a specific file.
- getFileContentWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Returns information about a specific file.
- getFileData() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Get the fileData property: The file_data property.
- getFileId() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Get the fileId property: The file_id property.
- getFileId() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Get the fileId property: The file_id property.
- getFileId() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Get the fileId property: The file_id property.
- getFileId() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Get the fileId property: The file_id property.
- getFileId() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFileCitation
-
Get the fileId property: The file_id property.
- getFileId() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath
-
Get the fileId property: The file_id property.
- 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.
- getFilename() - Method in class com.azure.ai.openai.models.CreateUploadRequest
-
Get the filename property: The name of the file to upload.
- getFilename() - Method in class com.azure.ai.openai.models.DataFileDetails
-
Get the filename property: The filename of the file.
- getFilename() - Method in class com.azure.ai.openai.models.FileDetails
-
Get the filename property: The filename of the file.
- getFilename() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the filename property: The name of the file.
- getFilename() - Method in class com.azure.ai.openai.models.Upload
-
Get the filename property: The name of the file to be uploaded.
- getFilename() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Get the filename property: The filename property.
- getFilename() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Get the filename property: The filename property.
- getFilepath() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation
-
Get the filepath property: The file path of the citation.
- getFilepath() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
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.MongoDBChatExtensionParametersFieldsMapping
-
Get the filepathField property: The filepath_field property.
- 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.
- getFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Returns information about a specific file.
- getFileWithResponse(String, RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Returns information about a specific file.
- getFilter() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Get the filter property: Search filter.
- getFilterReason() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Get the filterReason property: Represents the rationale for filtering the document.
- getFilters() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Get the filters property: The filters property.
- getFinalizingAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the finalizingAt property: The Unix timestamp (in seconds) for when the batch started finalizing.
- 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.
- getFirstId() - Method in class com.azure.ai.openai.models.PageableList
-
Get the firstId property: The first ID represented in this list.
- getFirstId() - Method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
-
Get the firstId property: The first_id property.
- getFormat() - Method in class com.azure.ai.openai.models.AudioOutputParameters
-
Get the format property: Specifies the output audio format.
- getFormat() - Method in class com.azure.ai.openai.models.InputAudioContent
-
Get the format property: The format of the audio data.
- getFormat() - Method in class com.azure.ai.openai.responses.models.ResponseTextOptions
-
Get the format property: The format property.
- 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.
- getGenerateSummary() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningConfiguration
-
Get the generateSummary property: The generate_summary property.
- 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.AudioResponseData
-
Get the id property: Unique identifier for this audio response.
- 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.Batch
-
Get the id property: The id assigned to the Batch.
- 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.
- getId() - Method in class com.azure.ai.openai.models.FileDeletionStatus
-
Get the id property: The ID of the resource specified for deletion.
- getId() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the id property: The identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.openai.models.Upload
-
Get the id property: The Upload unique identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.openai.models.UploadPart
-
Get the id property: The upload Part unique identifier, which can be referenced in API endpoints.
- getId() - Method in class com.azure.ai.openai.responses.models.DeleteResponseResponse
-
Get the id property: The id property.
- getId() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemSafetyCheck
-
Get the id property: The id property.
- getId() - Method in class com.azure.ai.openai.responses.models.ResponsesItem
-
Get the id property: The id property.
- getId() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the id property: A unique identifier for this Response.
- 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.
- getImageGenerationsWithResponse(String, ImageGenerationOptions, RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Creates an image given a prompt.
- getImageGenerationsWithResponse(String, ImageGenerationOptions, RequestOptions) - 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.
- getImageUrl() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Get the imageUrl property: The image_url property.
- getImageUrl() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Get the imageUrl property: The image_url property.
- getImageVectorFields() - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions
-
Get the imageVectorFields property: The names of fields that represent image vector data.
- getInclude() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the include property: Specifies additional output data to include in the model response.
- getIncludeContexts() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Get the includeContexts property: The included properties of the output context.
- getIncludeContexts() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Get the includeContexts property: The included properties of the output context.
- getIncludeContexts() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Get the includeContexts property: The included properties of the output context.
- getIncludeContexts() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Get the includeContexts property: The included properties of the output context.
- getIncludeContexts() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Get the includeContexts property: The included properties of the output context.
- getIncompleteDetails() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the incompleteDetails property: The incomplete_details property.
- getIndex() - Method in class com.azure.ai.openai.models.ChatChoice
-
Get the index property: The ordered index associated with this chat completions choice.
- getIndex() - Method in class com.azure.ai.openai.models.Choice
-
Get the index property: The ordered index associated with this completions choice.
- getIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFileCitation
-
Get the index property: The index property.
- getIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath
-
Get the index property: The index property.
- 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.MongoDBChatExtensionParameters
-
Get the indexName property: The name of the MongoDB index.
- getIndexName() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Get the indexName property: The name of the Pinecone database index.
- getIndirectAttack() - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt
-
Get the indirectAttack property: Whether an indirect attack was detected in the prompt.
- getInProgressAt() - Method in class com.azure.ai.openai.models.Batch
-
Get the inProgressAt property: The Unix timestamp (in seconds) for when the batch started processing.
- 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.
- getInput() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the input property: Text, image, or audio inputs to the model, used to generate a response.
- getInputAudio() - Method in class com.azure.ai.openai.models.ChatMessageAudioContentItem
-
Get the inputAudio property: The audio data.
- getInputFileId() - Method in class com.azure.ai.openai.models.Batch
-
Get the inputFileId property: The ID of the input file for the batch.
- getInputFileId() - Method in class com.azure.ai.openai.models.BatchCreateRequest
-
Get the inputFileId property: The ID of the input file for the batch.
- getInputTokens() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsage
-
Get the inputTokens property: The input_tokens property.
- 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.
- getInstructions() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the instructions property: The instructions property.
- getInstructions() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the instructions property: The instructions property.
- 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.
- getItem() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemAdded
-
Get the item property: The new output item created.
- getItem() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemDone
-
Get the item property: The completed output item.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallCompleted
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallInProgress
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallSearching
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallCompleted
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallInProgress
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallSearching
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDelta
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDone
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
-
Get the itemId property: The ID of the item that this stream event applies to.
- getItemId() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
-
Get the itemId property: The ID of the item that this stream event applies to.
- 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.
- getJsonSchema() - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormat
-
Get the jsonSchema property: The json_schema property.
- 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.
- getKey() - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchApiKeyAuthenticationOptions
-
Get the key property: The API 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.
- getKeys() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallKeyPressAction
-
Get the keys property: The keys property.
- 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.
- getLastId() - Method in class com.azure.ai.openai.models.PageableList
-
Get the lastId property: The last ID represented in this list.
- getLastId() - Method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
-
Get the lastId property: The last_id property.
- getLatest() - Static method in enum com.azure.ai.openai.OpenAIServiceVersion
-
Gets the latest service version supported by this client library.
- getLatest() - Static method in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
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.
- getLine() - Method in class com.azure.ai.openai.models.BatchErrorDatum
-
Get the line property: The line number of the input file where the error occurred, if applicable.
- getLines() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancement
-
Get the lines property: The lines of text detected by the grounding enhancement.
- getListContent() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getListContent() - Method in class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getListContent() - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getListContent() - Method in class com.azure.ai.openai.models.ChatRequestToolMessage
-
Get the chatMessageContentItem property: The content of the message.
- getListContent() - 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.
- 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.
- getMaxCompletionTokens() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the maxCompletionTokens property: An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
- getMaxNumResults() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Get the maxNumResults property: The max_num_results property.
- getMaxOutputTokens() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the maxOutputTokens property: An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).
- getMaxOutputTokens() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the maxOutputTokens property: The max_output_tokens property.
- getMaxSearchQueries() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- getMaxSearchQueries() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- getMaxSearchQueries() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- getMaxSearchQueries() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- getMaxSearchQueries() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Get the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- getMaxTokens() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the maxTokens property: The maximum number of tokens allowed for the generated answer.
- getMaxTokens() - Method in class com.azure.ai.openai.models.CompletionsOptions
-
Get the maxTokens property: The maximum number of tokens to generate.
- getMd5() - Method in class com.azure.ai.openai.models.CompleteUploadRequest
-
Get the md5 property: The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
- getMessage() - Method in class com.azure.ai.openai.models.BatchErrorDatum
-
Get the message property: A human-readable message providing more details about the error.
- getMessage() - Method in class com.azure.ai.openai.models.ChatChoice
-
Get the message property: The chat message for a given chat completions prompt.
- getMessage() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemSafetyCheck
-
Get the message property: The message property.
- getMessage() - Method in class com.azure.ai.openai.responses.models.ResponsesError
-
Get the message property: The message property.
- getMessage() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventError
-
Get the message property: The error message.
- 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.
- getMetadata() - Method in class com.azure.ai.openai.models.Batch
-
Get the metadata property: A set of key-value pairs that can be attached to the batch.
- getMetadata() - Method in class com.azure.ai.openai.models.BatchCreateRequest
-
Get the metadata property: A set of key-value pairs that can be attached to the batch.
- getMetadata() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the metadata property: Developer-defined tags and values used for filtering completions in the stored completions dashboard.
- getMetadata() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the metadata property: Set of 16 key-value pairs that can be attached to an object.
- getMetadata() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the metadata property: Set of 16 key-value pairs that can be attached to an object.
- getMimeType() - Method in class com.azure.ai.openai.models.CreateUploadRequest
-
Get the mimeType property: The MIME type of the file.
- getModalities() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the modalities property: Output types that you would like the model to generate for this 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.ChatCompletions
-
Get the model property: The model name used for this completions request.
- getModel() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the model property: The model name to provide as part of this completions request.
- getModel() - Method in class com.azure.ai.openai.models.CompletionsOptions
-
Get the model property: The model name to provide as part of this completions request.
- getModel() - Method in class com.azure.ai.openai.models.EmbeddingsOptions
-
Get the model property: The model name to provide as part of this embeddings request.
- 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.
- getModel() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the model property: Model ID used to generate the response, like `gpt-4o` or `o1`.
- getModel() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the model property: The model used to generate this Response.
- 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.ChatCompletionsFunctionToolDefinitionFunction
-
Get the name property: The name of the function to be called.
- 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.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Get the name property: The name of the response format.
- 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.ChatRequestDeveloperMessage
-
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.
- getName() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Get the name property: The name property.
- getName() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Get the name property: The name property.
- getName() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Get the name property: The name property.
- getName() - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFunction
-
Get the name property: The name property.
- getNamedToolSelection() - Method in class com.azure.ai.openai.models.ChatCompletionsToolSelection
-
Gets the named tool selection.
- 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.
- getObject() - Method in class com.azure.ai.openai.models.Batch
-
Get the object property: The object type, which is always `batch`.
- getObject() - Method in class com.azure.ai.openai.models.BatchErrorList
-
Get the object property: The object type, which is always `list`.
- getObject() - Method in class com.azure.ai.openai.models.EmbeddingItem
-
Get the object property: The object type which is always 'embedding'.
- getObject() - Method in class com.azure.ai.openai.models.FileDeletionStatus
-
Get the object property: The object type, which is always 'file'.
- getObject() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the object property: The object type, which is always 'file'.
- getObject() - Method in class com.azure.ai.openai.models.PageableList
-
Get the object property: The object type, which is always list.
- getObject() - Method in class com.azure.ai.openai.models.Upload
-
Get the object property: The object type, which is always "upload".
- getObject() - Method in class com.azure.ai.openai.models.UploadPart
-
Get the object property: The object type, which is always `upload.part`.
- getObject() - Method in class com.azure.ai.openai.responses.models.DeleteResponseResponse
-
Get the object property: The object property.
- getObject() - Method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
-
Get the object property: The object property.
- getObject() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the object property: The object type of this resource - always set to `response`.
- 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.
- getOriginalSearchScore() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Get the originalSearchScore property: The original search score of the retrieved document.
- getOutput() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Get the output property: The output property.
- getOutput() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
-
Get the output property: The output property.
- getOutput() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the output property: An array of content items generated by the model.
- getOutputFileId() - Method in class com.azure.ai.openai.models.Batch
-
Get the outputFileId property: The ID of the file containing the outputs of successfully executed requests.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallCompleted
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallInProgress
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallSearching
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallCompleted
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallInProgress
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallSearching
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDelta
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDone
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemAdded
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemDone
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
-
Get the outputIndex property: The index of the output item within the response that this stream event applies to.
- getOutputTokens() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsage
-
Get the outputTokens property: The output_tokens property.
- getOutputTokensDetails() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsage
-
Get the outputTokensDetails property: The output_tokens_details property.
- getParam() - Method in class com.azure.ai.openai.models.BatchErrorDatum
-
Get the param property: The name of the parameter that caused the error, if applicable.
- getParam() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventError
-
Get the param property: The parameter the error applies to, if applicable.
- 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.AzureSearchChatExtensionConfiguration
-
Get the parameters property: The parameters to use when configuring Azure Search.
- getParameters() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
-
Get the parameters property: The parameters property.
- 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.MongoDBChatExtensionConfiguration
-
Get the parameters property: The parameters for the MongoDB chat extension.
- getParameters() - Method in class com.azure.ai.openai.models.PineconeChatExtensionConfiguration
-
Get the parameters property: The parameters to use when configuring Azure OpenAI chat extensions.
- getParameters() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Get the parameters property: The parameters property.
- getPart() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
-
Get the part property: The initialized content part that was added.
- getPart() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
-
Get the part property: The initialized content part that was added.
- getPartIds() - Method in class com.azure.ai.openai.models.CompleteUploadRequest
-
Get the partIds property: The ordered list of Part IDs.
- getPassword() - Method in class com.azure.ai.openai.models.OnYourDataUsernameAndPasswordAuthenticationOptions
-
Get the password property: The password.
- getPath() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragAction
-
Get the path property: The path property.
- getPendingSafetyChecks() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Get the pendingSafetyChecks property: The pending safety checks for the computer call.
- 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.
- getPrediction() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the prediction property: Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time.
- 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.
- getPreset() - Method in class com.azure.ai.openai.models.ChatCompletionsToolSelection
-
Gets the preset tool selection.
- getPreviousResponseId() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the previousResponseId property: The unique ID of the previous response to the model.
- getPreviousResponseId() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the previousResponseId property: The unique ID of the previous response to the model.
- 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.
- 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.
- getPromptTokensDetails() - Method in class com.azure.ai.openai.models.CompletionsUsage
-
Get the promptTokensDetails property: Details of the prompt tokens.
- 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.
- getPurpose() - Method in class com.azure.ai.openai.models.CreateUploadRequest
-
Get the purpose property: The intended purpose of the uploaded file.
- getPurpose() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the purpose property: The intended purpose of a file.
- getPurpose() - Method in class com.azure.ai.openai.models.Upload
-
Get the purpose property: The intended purpose of the file.
- getQuality() - Method in class com.azure.ai.openai.models.ImageGenerationOptions
-
Get the quality property: The desired image generation quality level to use.
- getQueries() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
-
Get the queries property: The queries property.
- 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®.
- getRanker() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
-
Get the ranker property: The ranker property.
- getRankingOptions() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Get the rankingOptions property: The ranking_options property.
- getReason() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetails
-
Get the reason property: The reason property.
- getReasoning() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the reasoning property: The reasoning property.
- getReasoning() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the reasoning property: The reasoning property.
- getReasoningEffort() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the reasoningEffort property: This option is only valid for o1 models, Constrains effort on reasoning for reasoning models (see https://platform.openai.com/docs/guides/reasoning).
- getReasoningTokens() - Method in class com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails
-
Get the reasoningTokens property: Tokens generated by the model for reasoning.
- getReasoningTokens() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsageOutputTokensDetails
-
Get the reasoningTokens property: The reasoning_tokens property.
- getRefusal() - Method in class com.azure.ai.openai.models.ChatChoiceLogProbabilityInfo
-
Get the refusal property: The list of log probability information entries for the choice's message refusal message tokens, as requested via the 'logprobs' option.
- getRefusal() - Method in class com.azure.ai.openai.models.ChatMessageRefusalContentItem
-
Get the refusal property: The refusal message.
- getRefusal() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Get the refusal property: The refusal message by the assistant.
- getRefusal() - Method in class com.azure.ai.openai.models.ChatResponseMessage
-
Get the refusal property: The refusal message generated by the model.
- getRefusal() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentRefusal
-
Get the refusal property: The refusal property.
- getRefusal() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
-
Get the refusal property: The final refusal content.
- getRegion() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Get the region property: Free text input for the region of the user, e.g.
- getRejectedPredictionTokens() - Method in class com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails
-
Get the rejectedPredictionTokens property: When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion.
- getRequestCounts() - Method in class com.azure.ai.openai.models.Batch
-
Get the requestCounts property: The request counts for different statuses within the batch.
- getRerankScore() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation
-
Get the rerankScore property: The rerank score of the retrieved document.
- getRerankScore() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Get the rerankScore property: The rerank score of the retrieved document.
- getResponse() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCompleted
-
Get the response property: The completed response.
- getResponse() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCreated
-
Get the response property: The details of the initialized response.
- getResponse() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFailed
-
Get the response property: Detailed properties for the failed response.
- getResponse() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventIncomplete
-
Get the response property: Detailed properties for the incomplete response.
- getResponse() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventInProgress
-
Get the response property: Detailed properties for the response now in progress.
- getResponse(String) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Retrieves a model response with the given ID.
- getResponse(String) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Retrieves a model response with the given ID.
- getResponse(String, List<CreateResponsesRequestIncludable>) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Retrieves a model response with the given ID.
- getResponse(String, List<CreateResponsesRequestIncludable>) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Retrieves a model response with the given ID.
- 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.
- getResults() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
-
Get the results property: The results property.
- 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.ChatRequestAssistantMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatRequestFunctionMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatRequestMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatRequestToolMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatRequestUserMessage
-
Get the role property: The chat role associated with this message.
- getRole() - Method in class com.azure.ai.openai.models.ChatResponseMessage
-
Get the role property: The chat role associated with the message.
- getRole() - Method in class com.azure.ai.openai.responses.models.ResponsesAssistantMessage
-
Get the role property: The role associated with the message.
- getRole() - Method in class com.azure.ai.openai.responses.models.ResponsesDeveloperMessage
-
Get the role property: The role associated with the message.
- getRole() - Method in class com.azure.ai.openai.responses.models.ResponsesMessage
-
Get the role property: The role associated with the message.
- getRole() - Method in class com.azure.ai.openai.responses.models.ResponsesSystemMessage
-
Get the role property: The role associated with the message.
- getRole() - Method in class com.azure.ai.openai.responses.models.ResponsesUserMessage
-
Get the role property: The role associated with the message.
- getSchema() - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Get the schema property: The schema property.
- getSchema() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Get the schema property: The schema property.
- getScore() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Get the score property: The score property.
- getScoreThreshold() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
-
Get the scoreThreshold property: The score_threshold property.
- getScrollX() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Get the scrollX property: The scroll_x property.
- getScrollY() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Get the scrollY property: The scroll_y property.
- getSearchContextSize() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Get the searchContextSize property: The search_context_size property.
- getSearchQueries() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Get the searchQueries property: The search queries used to retrieve the document.
- 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.
- getSeed() - Method in class com.azure.ai.openai.models.CompletionsOptions
-
Get the seed property: If specified, our 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.
- getServiceTier() - Method in class com.azure.ai.openai.models.ChatCompletions
-
This field is not available in Azure OpenAI.
- getServiceTierOptions() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the
ServiceTierOptionsfor this request. - 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.
- getSourceIp() - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Get the sourceIp property: Captures the original client's IP address, accepting both IPv4 and IPv6 formats.
- 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.AudioTranscriptionWord
-
Get the start property: The start time of the word relative to the beginning of the audio, expressed in seconds.
- 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.
- getStartIndex() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Get the startIndex property: The start_index property.
- getStatus() - Method in class com.azure.ai.openai.models.Batch
-
Get the status property: The current status of the batch.
- getStatus() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the status property: The state of the file.
- getStatus() - Method in class com.azure.ai.openai.models.Upload
-
Get the status property: The status of the Upload.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Get the status property: The status of the item.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Get the status property: The status of the message input.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
-
Get the status property: The status property.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Get the status property: The status property.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
-
Get the status property: The status property.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesMessage
-
Get the status property: The status property.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItem
-
Get the status property: The status property.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the status property: The status of the response generation.
- getStatus() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchCallItem
-
Get the status property: The status property.
- getStatusDetails() - Method in class com.azure.ai.openai.models.OpenAIFile
-
Get the statusDetails property: The error message with details in case processing of this file failed.
- 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.
- getStreamOptions() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the streamOptions property: Options for streaming response.
- getStreamOptions() - Method in class com.azure.ai.openai.models.CompletionsOptions
-
Get the streamOptions property: Options for streaming response.
- 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.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.MongoDBChatExtensionParameters
-
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.
- getStringContent() - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getStringContent() - Method in class com.azure.ai.openai.models.ChatRequestDeveloperMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getStringContent() - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage
-
Get the content property: The contents of the user message, with available input types varying by selected model.
- getStringContent() - Method in class com.azure.ai.openai.models.ChatRequestToolMessage
-
Get the stringContent property: The content of the message.
- getStringContent() - 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.
- 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.
- getSummary() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItem
-
Get the summary property: The summary property.
- 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.
- getSystemFingerprint() - Method in class com.azure.ai.openai.models.Completions
-
Get the systemFingerprint property: This fingerprint represents the backend configuration that the model runs with.
- 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.
- getTemperature() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- getTemperature() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the temperature property: What sampling temperature to use, between 0 and 2.
- 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.
- getText() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallTypeAction
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentText
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentText
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElementSummaryText
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the text property: The text property.
- getText() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
-
Get the text property: The final text content.
- getTextOffsets() - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel
-
Get the textOffsets property: The text offsets associated with tokens in this completions data.
- getTimestampGranularities() - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions
-
Get the timestampGranularities property: The timestamp granularities to populate for this transcription.
- getTimezone() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Get the timezone property: The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g.
- Getting started - Search tag in Overview
- Section
- getTitle() - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation
-
Get the title property: The title of the citation.
- getTitle() - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
-
Get the title property: The title of the citation.
- getTitle() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Get the title property: The title property.
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Get the titleField property: The title_field property.
- 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.
- getToolChoice() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the toolChoice property: How the model should select which tool (or tools) to use when generating a response.
- getToolChoice() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the toolChoice property: The tool_choice property.
- 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.
- getTools() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the tools property: The tools to use to generate a response.
- getTools() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the tools property: The tools available to the model when generating a Response.
- 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.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.MongoDBChatExtensionParameters
-
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.
- getTopP() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTopP() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- getTotal() - Method in class com.azure.ai.openai.models.BatchRequestCounts
-
Get the total property: Total number of requests in the batch.
- 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.
- getTotalTokens() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsage
-
Get the totalTokens property: The total_tokens property.
- getTranscript() - Method in class com.azure.ai.openai.models.AudioResponseData
-
Get the transcript property: Transcript of the audio generated by the model.
- getTruncation() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the truncation property: The truncation strategy to use for the model response
- getTruncation() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the truncation property: The truncation strategy to use for the model response
- getType() - Method in class com.azure.ai.openai.models.AzureChatExtensionConfiguration
-
Get the type property: The label for the type of an Azure chat extension.
- getType() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionConfiguration
-
Get the type property: The label for the type of an Azure chat extension.
- getType() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionConfiguration
-
Get the type property: The label for the type of an Azure chat extension.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsJsonResponseFormat
-
Get the type property: The discriminated type for the response format.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormat
-
Get the type property: The discriminated type for the response format.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsNamedFunctionToolSelection
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsNamedToolSelection
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsResponseFormat
-
Get the type property: The discriminated type for the response format.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsTextResponseFormat
-
Get the type property: The discriminated type for the response format.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsToolCall
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatCompletionsToolDefinition
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatFinishDetails
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.ChatMessageAudioContentItem
-
Get the type property: The discriminated object type.
- getType() - Method in class com.azure.ai.openai.models.ChatMessageContentItem
-
Get the type property: The discriminated object type.
- getType() - Method in class com.azure.ai.openai.models.ChatMessageImageContentItem
-
Get the type property: The discriminated object type.
- getType() - Method in class com.azure.ai.openai.models.ChatMessageRefusalContentItem
-
Get the type property: The discriminated object type.
- getType() - Method in class com.azure.ai.openai.models.ChatMessageTextContentItem
-
Get the type property: The discriminated object type.
- getType() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionConfiguration
-
Get the type property: The label for the type of an Azure chat extension.
- getType() - Method in class com.azure.ai.openai.models.MaxTokensFinishDetails
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionConfiguration
-
Get the type property: The label for the type of an Azure chat extension.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataApiKeyAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataConnectionStringAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource
-
Get the type property: The type of vectorization source to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataEncodedApiKeyAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource
-
Get the type property: The type of vectorization source to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataIntegratedVectorizationSource
-
Get the type property: The type of vectorization source to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataModelIdVectorizationSource
-
Get the type property: The type of vectorization source to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataSystemAssignedManagedIdentityAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataUserAssignedManagedIdentityAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataUsernameAndPasswordAuthenticationOptions
-
Get the type property: The authentication type.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataVectorizationSource
-
Get the type property: The type of vectorization source to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchAccessTokenAuthenticationOptions
-
Get the type property: The type of authentication to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchApiKeyAuthenticationOptions
-
Get the type property: The type of authentication to use.
- getType() - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions
-
Get the type property: The type of authentication to use.
- getType() - Method in class com.azure.ai.openai.models.PineconeChatExtensionConfiguration
-
Get the type property: The label for the type of an Azure chat extension.
- getType() - Method in class com.azure.ai.openai.models.PredictionContent
-
Get the type property: The type of the predicted content you want to provide.
- getType() - Method in class com.azure.ai.openai.models.StopFinishDetails
-
Get the type property: The object type.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesAssistantMessage
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDoubleClickAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallKeyPressAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallMoveAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutput
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScreenshotAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallTypeAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallWaitAction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerTool
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesContent
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesDeveloperMessage
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentText
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesItemReferenceItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesMessage
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentRefusal
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentText
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotation
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFileCitation
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElement
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElementSummaryText
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallCompleted
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallInProgress
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallSearching
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEvent
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCompleted
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCreated
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventError
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFailed
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallCompleted
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallInProgress
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallSearching
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDelta
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDone
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventIncomplete
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventInProgress
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemAdded
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemDone
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesSystemMessage
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormat
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonObject
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatText
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesTool
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObject
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectComputer
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFileSearch
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFunction
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectWebSearch
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesUserMessage
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchCallItem
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchLocation
-
Get the type property: The type property.
- getType() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Get the type property: The type property.
- getUngroundedMaterial() - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice
-
Get the ungroundedMaterial property: Information about detection of ungrounded material.
- getUploadId() - Method in class com.azure.ai.openai.models.UploadPart
-
Get the uploadId property: The ID of the Upload object that this Part was added to.
- 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.AzureChatExtensionRetrievedDocument
-
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.
- getUrl() - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Get the url property: The url property.
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Get the urlField property: The url_field property.
- 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.
- getUsage() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the usage property: The usage property.
- 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.
- getUser() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the user property: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
- getUser() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the user property: The user property.
- getUserLocation() - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Get the userLocation property: The user_location property.
- getUsername() - Method in class com.azure.ai.openai.models.OnYourDataUsernameAndPasswordAuthenticationOptions
-
Get the username property: The username.
- getUserSecurityContext() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the userSecurityContext property: The security context identifies and authenticates users and applications in your multi-tenant AI system, helping security teams investigate and mitigate incidents.
- 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.
- getVectorFields() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParametersFieldsMapping
-
Get the vectorFields property: The vector_fields property.
- getVectorStoreIds() - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Get the vectorStoreIds property: The vector_store_ids property.
- getVersion() - Method in enum com.azure.ai.openai.OpenAIServiceVersion
- getVersion() - Method in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
- 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.AudioOutputParameters
-
Get the voice property: Specifies the voice type.
- getVoice() - Method in class com.azure.ai.openai.models.SpeechGenerationOptions
-
Get the voice property: The voice to use for text-to-speech.
- getWord() - Method in class com.azure.ai.openai.models.AudioTranscriptionWord
-
Get the word property: The textual content of the word.
- getWords() - Method in class com.azure.ai.openai.models.AudioTranscription
-
Get the words property: A collection of information about the timing of each processed word.
- getX() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementCoordinatePoint
-
Get the x property: The x-coordinate (horizontal axis) of the point.
- getX() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
-
Get the x property: The x property.
- getX() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDoubleClickAction
-
Get the x property: The x property.
- getX() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragActionPath
-
Get the x property: The x property.
- getX() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallMoveAction
-
Get the x property: The x property.
- getX() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Get the x property: The x property.
- getY() - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementCoordinatePoint
-
Get the y property: The y-coordinate (vertical axis) of the point.
- getY() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
-
Get the y property: The y property.
- getY() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDoubleClickAction
-
Get the y property: The y property.
- getY() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragActionPath
-
Get the y property: The y property.
- getY() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallMoveAction
-
Get the y property: The y property.
- getY() - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Get the y property: The y property.
- GPT_3_5_TURBO - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo for CreateResponsesRequestModel.
- GPT_3_5_TURBO_0125 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo-0125 for CreateResponsesRequestModel.
- GPT_3_5_TURBO_0301 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo-0301 for CreateResponsesRequestModel.
- GPT_3_5_TURBO_0613 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo-0613 for CreateResponsesRequestModel.
- GPT_3_5_TURBO_1106 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo-1106 for CreateResponsesRequestModel.
- GPT_3_5_TURBO_16K - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo-16k for CreateResponsesRequestModel.
- GPT_3_5_TURBO_16K_0613 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-3.5-turbo-16k-0613 for CreateResponsesRequestModel.
- GPT_4 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4 for CreateResponsesRequestModel.
- GPT_4_0125_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-0125-preview for CreateResponsesRequestModel.
- GPT_4_0314 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-0314 for CreateResponsesRequestModel.
- GPT_4_0613 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-0613 for CreateResponsesRequestModel.
- GPT_4_1106_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-1106-preview for CreateResponsesRequestModel.
- GPT_4_32K - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-32k for CreateResponsesRequestModel.
- GPT_4_32K_0314 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-32k-0314 for CreateResponsesRequestModel.
- GPT_4_32K_0613 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-32k-0613 for CreateResponsesRequestModel.
- GPT_4_5_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4.5-preview for CreateResponsesRequestModel.
- GPT_4_5_PREVIEW_2025_02_27 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4.5-preview-2025-02-27 for CreateResponsesRequestModel.
- GPT_4_TURBO - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-turbo for CreateResponsesRequestModel.
- GPT_4_TURBO_2024_04_09 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-turbo-2024-04-09 for CreateResponsesRequestModel.
- GPT_4_TURBO_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-turbo-preview for CreateResponsesRequestModel.
- GPT_4_VISION_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4-vision-preview for CreateResponsesRequestModel.
- GPT_4O - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o for CreateResponsesRequestModel.
- GPT_4O_2024_05_13 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-2024-05-13 for CreateResponsesRequestModel.
- GPT_4O_2024_08_06 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-2024-08-06 for CreateResponsesRequestModel.
- GPT_4O_2024_11_20 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-2024-11-20 for CreateResponsesRequestModel.
- GPT_4O_AUDIO_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-audio-preview for CreateResponsesRequestModel.
- GPT_4O_AUDIO_PREVIEW_2024_10_01 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-audio-preview-2024-10-01 for CreateResponsesRequestModel.
- GPT_4O_AUDIO_PREVIEW_2024_12_17 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-audio-preview-2024-12-17 for CreateResponsesRequestModel.
- GPT_4O_MINI - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-mini for CreateResponsesRequestModel.
- GPT_4O_MINI_2024_07_18 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-mini-2024-07-18 for CreateResponsesRequestModel.
- GPT_4O_MINI_AUDIO_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-mini-audio-preview for CreateResponsesRequestModel.
- GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value gpt-4o-mini-audio-preview-2024-12-17 for CreateResponsesRequestModel.
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 - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
-
Enum value high.
- HIGH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
-
Enum value high.
- HIGH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
-
Enum value high.
- 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.
- HIGH - Static variable in class com.azure.ai.openai.models.ReasoningEffortValue
-
The reasoning effort is high.
- httpClient(HttpClient) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- httpClient(HttpClient) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
I
- Image Generation - Search tag in Overview
- Section
- 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. - IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Enum value in_progress.
- IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Enum value in_progress.
- IN_PROGRESS - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The input file was successfully validated and the batch is currently being executed.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
-
Enum value incomplete.
- INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Enum value incomplete.
- INPUT_FILE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Enum value input_file.
- INPUT_IMAGE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Enum value input_image.
- INPUT_TEXT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Enum value input_text.
- InputAudioContent - Class in com.azure.ai.openai.models
-
A structured chat content item containing audio data.
- InputAudioContent(byte[], InputAudioFormat) - Constructor for class com.azure.ai.openai.models.InputAudioContent
-
Creates an instance of InputAudioContent class.
- InputAudioContent(String, InputAudioFormat) - Constructor for class com.azure.ai.openai.models.InputAudioContent
-
Creates an instance of InputAudioContent class.
- InputAudioFormat - Class in com.azure.ai.openai.models
-
Values to describe the format of the input audio data.
- InputAudioFormat() - Constructor for class com.azure.ai.openai.models.InputAudioFormat
-
Deprecated.Use the
InputAudioFormat.fromString(String)factory method. - INTEGRATED - Static variable in class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Represents the integrated vectorizer defined within the search resource.
- INTENT - Static variable in class com.azure.ai.openai.models.OnYourDataContextProperty
-
The `intent` property.
- isAllowPartialResult() - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- isAllowPartialResult() - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- isAllowPartialResult() - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- isAllowPartialResult() - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- isAllowPartialResult() - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Get the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- isDeleted() - Method in class com.azure.ai.openai.models.FileDeletionStatus
-
Get the deleted property: A value indicating whether deletion was successful.
- isDeleted() - Method in class com.azure.ai.openai.responses.models.DeleteResponseResponse
-
Get the deleted property: The deleted property.
- 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.ContentFilterCompletionTextSpanResult
-
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.ContentFilterCompletionTextSpanResult
-
Get the filtered property: A value indicating whether or not the content has been filtered.
- isFiltered() - Method in class com.azure.ai.openai.models.ContentFilterDetailedResults
-
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.
- isHasMore() - Method in class com.azure.ai.openai.models.PageableList
-
Get the hasMore property: A value indicating whether there are additional values available not captured in this list.
- isHasMore() - Method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
-
Get the hasMore property: The has_more property.
- isIncludeUsage() - Method in class com.azure.ai.openai.models.ChatCompletionStreamOptions
-
Get the includeUsage property: If set, an additional chunk will be streamed before the `data: [DONE]` message.
- 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.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.MongoDBChatExtensionParameters
-
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.
- isParallelToolCalls() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the parallelToolCalls property: Whether to enable parallel function calling during tool use.
- isParallelToolCalls() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the parallelToolCalls property: Specifies whether parallel tool calling should be enabled for this response.
- isParallelToolCalls() - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
-
Get the parallelToolCalls property: The parallel_tool_calls property.
- isStore() - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Get the store property: Whether or not to store the output of this chat completion request for use in our model distillation or evaluation products.
- isStore() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the store property: The store property.
- 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.
- isStream() - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Get the stream property: If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format).
- isStrict() - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
-
Get the strict property: Whether to enable strict schema adherence when generating the function call.
- isStrict() - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Get the strict property: Whether to enable strict schema adherence when generating the output.
- isStrict() - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Get the strict property: The strict property.
- isStrict() - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Get the strict property: The strict property.
- ITEM_REFERENCE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value item_reference.
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.
- JSON_OBJECT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
-
Enum value json_object.
- JSON_SCHEMA - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
-
Enum value json_schema.
K
- KEY_AND_KEY_ID - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via key and key ID pair.
- Key concepts - Search tag in Overview
- Section
- KEYPRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value keypress.
L
- LEFT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Enum value left.
- Legacy completions - Search tag in Overview
- Section
- listBatches() - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets a list of all batches owned by the Azure OpenAI resource.
- listBatches() - Method in class com.azure.ai.openai.OpenAIClient
-
Gets a list of all batches owned by the Azure OpenAI resource.
- listBatches(String, Integer) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets a list of all batches owned by the Azure OpenAI resource.
- listBatches(String, Integer) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets a list of all batches owned by the Azure OpenAI resource.
- listBatchesWithResponse(RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets a list of all batches owned by the Azure OpenAI resource.
- listBatchesWithResponse(RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets a list of all batches owned by the Azure OpenAI resource.
- listFiles() - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets a list of previously uploaded files.
- listFiles() - Method in class com.azure.ai.openai.OpenAIClient
-
Gets a list of previously uploaded files.
- listFiles(FilePurpose) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets a list of previously uploaded files.
- listFiles(FilePurpose) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets a list of previously uploaded files.
- listFilesWithResponse(RequestOptions) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Gets a list of previously uploaded files.
- listFilesWithResponse(RequestOptions) - Method in class com.azure.ai.openai.OpenAIClient
-
Gets a list of previously uploaded files.
- listInputItems(String, Integer, ListInputItemsRequestOrder) - Method in class com.azure.ai.openai.responses.ResponsesAsyncClient
-
Returns a list of input items for a given response.
- listInputItems(String, Integer, ListInputItemsRequestOrder) - Method in class com.azure.ai.openai.responses.ResponsesClient
-
Returns a list of input items for a given response.
- ListInputItemsRequestOrder - Enum in com.azure.ai.openai.responses.models
-
Defines values for ListInputItemsRequestOrder.
- LOW - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
-
Enum value low.
- LOW - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
-
Enum value low.
- LOW - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
-
Enum value low.
- 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.
- LOW - Static variable in class com.azure.ai.openai.models.ReasoningEffortValue
-
The reasoning effort is low.
M
- MAC - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Enum value mac.
- MAX_OUTPUT_TOKENS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetailsReason
-
Enum value max_output_tokens.
- 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 - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
-
Enum value medium.
- MEDIUM - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
-
Enum value medium.
- 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.
- MEDIUM - Static variable in class com.azure.ai.openai.models.ReasoningEffortValue
-
The reasoning effort is medium.
- MESSAGE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value message.
- MESSAGE_INPUT_IMAGE_IMAGE_URL - Enum constant in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
-
Enum value message.input_image.image_url.
- MODEL_ID - Static variable in class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Represents a specific embedding model ID as defined in the search service.
- MONGO_DB - Static variable in class com.azure.ai.openai.models.AzureChatExtensionType
-
Represents the use of a MongoDB chat extension.
- MongoDBChatExtensionConfiguration - Class in com.azure.ai.openai.models
-
A specific representation of configurable options for a MongoDB chat extension configuration.
- MongoDBChatExtensionConfiguration(MongoDBChatExtensionParameters) - Constructor for class com.azure.ai.openai.models.MongoDBChatExtensionConfiguration
-
Creates an instance of MongoDBChatExtensionConfiguration class.
- MongoDBChatExtensionParameters - Class in com.azure.ai.openai.models
-
Parameters for the MongoDB chat extension.
- MongoDBChatExtensionParameters(String, String, String, String, String, MongoDBChatExtensionParametersFieldsMapping, BinaryData) - Constructor for class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Creates an instance of MongoDBChatExtensionParameters class.
- MongoDBChatExtensionParametersFieldsMapping - Class in com.azure.ai.openai.models
-
The MongoDBChatExtensionParametersFieldsMapping model.
- MongoDBChatExtensionParametersFieldsMapping(List<String>, List<String>) - Constructor for class com.azure.ai.openai.models.MongoDBChatExtensionParametersFieldsMapping
-
Creates an instance of MongoDBChatExtensionParametersFieldsMapping class.
- MOVE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value move.
- MP3 - Static variable in class com.azure.ai.openai.models.InputAudioFormat
-
Specifies that the audio data is in the MP3 format.
- MP3 - Static variable in class com.azure.ai.openai.models.OutputAudioFormat
-
The output audio format is MP3.
- 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.
- Next steps - Search tag in Overview
- Section
- NONE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
-
Enum value none.
- 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
- O1 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o1 for CreateResponsesRequestModel.
- O1_2024_12_17 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o1-2024-12-17 for CreateResponsesRequestModel.
- O1_MINI - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o1-mini for CreateResponsesRequestModel.
- O1_MINI_2024_09_12 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o1-mini-2024-09-12 for CreateResponsesRequestModel.
- O1_PREVIEW - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o1-preview for CreateResponsesRequestModel.
- O1_PREVIEW_2024_09_12 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o1-preview-2024-09-12 for CreateResponsesRequestModel.
- O3_MINI - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o3-mini for CreateResponsesRequestModel.
- O3_MINI_2025_01_31 - Static variable in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Static value o3-mini-2025-01-31 for CreateResponsesRequestModel.
- 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.
- OnYourDataAuthenticationType - Class in com.azure.ai.openai.models
-
The authentication types supported with Azure OpenAI On Your Data.
- OnYourDataAuthenticationType() - Constructor for class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Deprecated.Use the
OnYourDataAuthenticationType.fromString(String)factory method. - 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.
- OnYourDataContextProperty - Class in com.azure.ai.openai.models
-
The context property.
- OnYourDataContextProperty() - Constructor for class com.azure.ai.openai.models.OnYourDataContextProperty
-
Deprecated.Use the
OnYourDataContextProperty.fromString(String)factory method. - 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, OnYourDataVectorSearchAuthenticationOptions) - Constructor for class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource
-
Creates an instance of OnYourDataEndpointVectorizationSource class.
- OnYourDataIntegratedVectorizationSource - Class in com.azure.ai.openai.models
-
Represents the integrated vectorizer defined within the search resource.
- OnYourDataIntegratedVectorizationSource() - Constructor for class com.azure.ai.openai.models.OnYourDataIntegratedVectorizationSource
-
Creates an instance of OnYourDataIntegratedVectorizationSource 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.
- OnYourDataUsernameAndPasswordAuthenticationOptions - Class in com.azure.ai.openai.models
-
The authentication options for Azure OpenAI On Your Data when using a username and password.
- OnYourDataUsernameAndPasswordAuthenticationOptions(String, String) - Constructor for class com.azure.ai.openai.models.OnYourDataUsernameAndPasswordAuthenticationOptions
-
Creates an instance of OnYourDataUsernameAndPasswordAuthenticationOptions 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.
- OnYourDataVectorizationSourceType - Class in com.azure.ai.openai.models
-
Represents the available sources Azure OpenAI On Your Data can use to configure vectorization of data for use with vector search.
- OnYourDataVectorizationSourceType() - Constructor for class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Deprecated.Use the
OnYourDataVectorizationSourceType.fromString(String)factory method. - OnYourDataVectorSearchAccessTokenAuthenticationOptions - Class in com.azure.ai.openai.models
-
The authentication options for Azure OpenAI On Your Data vector search when using access token.
- OnYourDataVectorSearchAccessTokenAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataVectorSearchAccessTokenAuthenticationOptions
-
Creates an instance of OnYourDataVectorSearchAccessTokenAuthenticationOptions class.
- OnYourDataVectorSearchApiKeyAuthenticationOptions - Class in com.azure.ai.openai.models
-
The authentication options for Azure OpenAI On Your Data when using an API key.
- OnYourDataVectorSearchApiKeyAuthenticationOptions(String) - Constructor for class com.azure.ai.openai.models.OnYourDataVectorSearchApiKeyAuthenticationOptions
-
Creates an instance of OnYourDataVectorSearchApiKeyAuthenticationOptions class.
- OnYourDataVectorSearchAuthenticationOptions - Class in com.azure.ai.openai.models
-
The authentication options for Azure OpenAI On Your Data vector search.
- OnYourDataVectorSearchAuthenticationOptions() - Constructor for class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions
-
Creates an instance of OnYourDataVectorSearchAuthenticationOptions class.
- OnYourDataVectorSearchAuthenticationType - Class in com.azure.ai.openai.models
-
The authentication types supported with Azure OpenAI On Your Data vector search.
- OnYourDataVectorSearchAuthenticationType() - Constructor for class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationType
-
Deprecated.Use the
OnYourDataVectorSearchAuthenticationType.fromString(String)factory method. - 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.
- OpenAIFile - Class in com.azure.ai.openai.models
-
Represents an assistant that can call the model and use tools.
- OpenAIServiceVersion - Enum in com.azure.ai.openai
-
Service version of OpenAIClient.
- OPUS - Static variable in class com.azure.ai.openai.models.OutputAudioFormat
-
The output audio format is OPUS.
- OPUS - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat
-
Use Opus as the audio output format.
- OUTPUT_TEXT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Enum value output_text.
- OutputAudioFormat - Class in com.azure.ai.openai.models
-
The output audio format.
- OutputAudioFormat() - Constructor for class com.azure.ai.openai.models.OutputAudioFormat
-
Deprecated.Use the
OutputAudioFormat.fromString(String)factory method.
P
- PageableList<T> - Class in com.azure.ai.openai.models
-
The response data for a requested list of items.
- PageableList() - Constructor for class com.azure.ai.openai.models.PageableList
-
Creates an instance of PageableList class.
- PCM - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat
-
Use uncompressed PCM as the audio output format, which is similar to WAV but contains raw samples in 24kHz (16-bit signed, low-endian), without the header.
- PCM16 - Static variable in class com.azure.ai.openai.models.OutputAudioFormat
-
The output audio format is PCM16.
- PENDING - Static variable in class com.azure.ai.openai.models.FileState
-
The operation was created and is not queued to be processed in the future.
- PENDING - Static variable in class com.azure.ai.openai.models.UploadStatus
-
Static value pending for UploadStatus.
- PINECONE - Static variable in class com.azure.ai.openai.models.AzureChatExtensionType
-
Represents the use of Pinecone index as an Azure OpenAI chat extension.
- 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
-
.
- pipeline(HttpPipeline) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- PredictionContent - Class in com.azure.ai.openai.models
-
Static predicted output content, such as the content of a text file that is being regenerated.
- PredictionContent(BinaryData) - Constructor for class com.azure.ai.openai.models.PredictionContent
-
Creates an instance of PredictionContent class.
- PredictionContentType - Class in com.azure.ai.openai.models
-
The types of predicted content.
- PredictionContentType() - Constructor for class com.azure.ai.openai.models.PredictionContentType
-
Deprecated.Use the
PredictionContentType.fromString(String)factory method. - Prerequisites - Search tag in Overview
- Section
- PROCESSED - Static variable in class com.azure.ai.openai.models.FileState
-
The operation has successfully processed and is ready for consumption.
R
- REASONING - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value reasoning.
- ReasoningEffortValue - Class in com.azure.ai.openai.models
-
Values for the reasoning.
- ReasoningEffortValue() - Constructor for class com.azure.ai.openai.models.ReasoningEffortValue
-
Deprecated.Use the
ReasoningEffortValue.fromString(String)factory method. - REFUSAL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Enum value refusal.
- REQUIRED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
-
Enum value required.
- REQUIRED - Static variable in class com.azure.ai.openai.models.ChatCompletionsToolSelectionPreset
-
Specifies that the model must call one or more tools.
- RERANK - Enum constant in enum com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
-
The document is not filtered by original search score threshold, but is filtered by rerank score and `top_n_documents` configure.
- RESPONSE_COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.completed.
- RESPONSE_CONTENT_PART_ADDED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.content_part.added.
- RESPONSE_CONTENT_PART_DONE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.content_part.done.
- RESPONSE_CREATED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.created.
- RESPONSE_FAILED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.failed.
- RESPONSE_FILE_SEARCH_CALL_COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.file_search_call.completed.
- RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.file_search_call.in.progress.
- RESPONSE_FILE_SEARCH_CALL_SEARCHING - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.file_search_call.searching.
- RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.function_call_arguments.delta.
- RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.function_call_arguments.done.
- RESPONSE_IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.in_progress.
- RESPONSE_INCOMPLETE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.incomplete.
- RESPONSE_OUTPUT_ITEM_ADDED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.output_item.added.
- RESPONSE_OUTPUT_ITEM_DONE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.output_item.done.
- RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.output_text.annotation.added.
- RESPONSE_OUTPUT_TEXT_DELTA - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.output_text.delta.
- RESPONSE_OUTPUT_TEXT_DONE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.output_text.done.
- RESPONSE_REFUSAL_DELTA - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.refusal.delta.
- RESPONSE_REFUSAL_DONE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.refusal.done.
- RESPONSE_WEB_SEARCH_CALL_COMPLETED - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.web_search_call.completed.
- RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.web_search_call.in_progress.
- RESPONSE_WEB_SEARCH_CALL_SEARCHING - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Enum value response.web_search_call.searching.
- ResponseOutputTextAnnotationType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponseOutputTextAnnotationType.
- Responses - Search tag in Overview
- Section
- ResponsesAssistantMessage - Class in com.azure.ai.openai.responses.models
-
A message item with the `assistant` role.
- ResponsesAssistantMessage(List<ResponsesContent>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesAssistantMessage
-
Creates an instance of ResponsesAssistantMessage class.
- ResponsesAsyncClient - Class in com.azure.ai.openai.responses
-
Initializes a new instance of the asynchronous ResponsesClient type.
- ResponsesClient - Class in com.azure.ai.openai.responses
-
Initializes a new instance of the synchronous ResponsesClient type.
- ResponsesClientBuilder - Class in com.azure.ai.openai.responses
-
A builder for creating a new instance of the ResponsesClient type.
- ResponsesClientBuilder() - Constructor for class com.azure.ai.openai.responses.ResponsesClientBuilder
-
Create an instance of the ResponsesClientBuilder.
- ResponsesComputerCallActionType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesComputerCallActionType.
- ResponsesComputerCallClickAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallClickAction model.
- ResponsesComputerCallClickAction(ResponsesComputerCallClickButtonType, int, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
-
Creates an instance of ResponsesComputerCallClickAction class.
- ResponsesComputerCallClickButtonType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesComputerCallClickButtonType.
- ResponsesComputerCallDoubleClickAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallDoubleClickAction model.
- ResponsesComputerCallDoubleClickAction(int, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallDoubleClickAction
-
Creates an instance of ResponsesComputerCallDoubleClickAction class.
- ResponsesComputerCallDragAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallDragAction model.
- ResponsesComputerCallDragAction(List<ResponsesComputerCallDragActionPath>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallDragAction
-
Creates an instance of ResponsesComputerCallDragAction class.
- ResponsesComputerCallDragActionPath - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallDragActionPath model.
- ResponsesComputerCallDragActionPath(int, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallDragActionPath
-
Creates an instance of ResponsesComputerCallDragActionPath class.
- ResponsesComputerCallItem - Class in com.azure.ai.openai.responses.models
-
A tool call to a computer use tool.
- ResponsesComputerCallItem(String, ResponsesComputerCallItemAction, List<ResponsesComputerCallItemSafetyCheck>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
-
Creates an instance of ResponsesComputerCallItem class.
- ResponsesComputerCallItemAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallItemAction model.
- ResponsesComputerCallItemAction() - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallItemAction
-
Creates an instance of ResponsesComputerCallItemAction class.
- ResponsesComputerCallItemSafetyCheck - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallItemSafetyCheck model.
- ResponsesComputerCallItemSafetyCheck(String, String, String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallItemSafetyCheck
-
Creates an instance of ResponsesComputerCallItemSafetyCheck class.
- ResponsesComputerCallItemStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesComputerCallItemStatus.
- ResponsesComputerCallKeyPressAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallKeyPressAction model.
- ResponsesComputerCallKeyPressAction(List<String>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallKeyPressAction
-
Creates an instance of ResponsesComputerCallKeyPressAction class.
- ResponsesComputerCallMoveAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallMoveAction model.
- ResponsesComputerCallMoveAction(int, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallMoveAction
-
Creates an instance of ResponsesComputerCallMoveAction class.
- ResponsesComputerCallOutputItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallOutputItem model.
- ResponsesComputerCallOutputItem(String, List<ResponsesComputerCallItemSafetyCheck>, ResponsesComputerCallOutputItemOutput) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
-
Creates an instance of ResponsesComputerCallOutputItem class.
- ResponsesComputerCallOutputItemOutput - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallOutputItemOutput model.
- ResponsesComputerCallOutputItemOutput() - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutput
-
Creates an instance of ResponsesComputerCallOutputItemOutput class.
- ResponsesComputerCallOutputItemOutputType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesComputerCallOutputItemOutputType.
- ResponsesComputerCallOutputItemScreenshot - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallOutputItemScreenshot model.
- ResponsesComputerCallOutputItemScreenshot() - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Creates an instance of ResponsesComputerCallOutputItemScreenshot class.
- ResponsesComputerCallOutputItemStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesComputerCallOutputItemStatus.
- ResponsesComputerCallScreenshotAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallScreenshotAction model.
- ResponsesComputerCallScreenshotAction() - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallScreenshotAction
-
Creates an instance of ResponsesComputerCallScreenshotAction class.
- ResponsesComputerCallScrollAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallScrollAction model.
- ResponsesComputerCallScrollAction(int, int, int, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
-
Creates an instance of ResponsesComputerCallScrollAction class.
- ResponsesComputerCallTypeAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallTypeAction model.
- ResponsesComputerCallTypeAction(String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallTypeAction
-
Creates an instance of ResponsesComputerCallTypeAction class.
- ResponsesComputerCallWaitAction - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerCallWaitAction model.
- ResponsesComputerCallWaitAction() - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerCallWaitAction
-
Creates an instance of ResponsesComputerCallWaitAction class.
- ResponsesComputerTool - Class in com.azure.ai.openai.responses.models
-
The ResponsesComputerTool model.
- ResponsesComputerTool(int, int, ResponsesComputerToolEnvironment) - Constructor for class com.azure.ai.openai.responses.models.ResponsesComputerTool
-
Creates an instance of ResponsesComputerTool class.
- ResponsesComputerToolEnvironment - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesComputerToolEnvironment.
- ResponsesContent - Class in com.azure.ai.openai.responses.models
-
The ResponsesContent model.
- ResponsesContent() - Constructor for class com.azure.ai.openai.responses.models.ResponsesContent
-
Creates an instance of ResponsesContent class.
- ResponsesContentType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesContentType.
- ResponsesDeveloperMessage - Class in com.azure.ai.openai.responses.models
-
A message item with the `developer` role.
- ResponsesDeveloperMessage(List<ResponsesContent>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesDeveloperMessage
-
Creates an instance of ResponsesDeveloperMessage class.
- ResponsesError - Class in com.azure.ai.openai.responses.models
-
The ResponsesError model.
- ResponsesFileSearchCallItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesFileSearchCallItem model.
- ResponsesFileSearchCallItem(List<String>, List<ResponsesFileSearchCallItemResult>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
-
Creates an instance of ResponsesFileSearchCallItem class.
- ResponsesFileSearchCallItemResult - Class in com.azure.ai.openai.responses.models
-
The ResponsesFileSearchCallItemResult model.
- ResponsesFileSearchCallItemResult() - Constructor for class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Creates an instance of ResponsesFileSearchCallItemResult class.
- ResponsesFileSearchCallItemStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesFileSearchCallItemStatus.
- ResponsesFileSearchTool - Class in com.azure.ai.openai.responses.models
-
The ResponsesFileSearchTool model.
- ResponsesFileSearchTool(List<String>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Creates an instance of ResponsesFileSearchTool class.
- ResponsesFileSearchToolRankingOptions - Class in com.azure.ai.openai.responses.models
-
The ResponsesFileSearchToolRankingOptions model.
- ResponsesFileSearchToolRankingOptions() - Constructor for class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
-
Creates an instance of ResponsesFileSearchToolRankingOptions class.
- ResponsesFileSearchToolRankingOptionsRanker - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesFileSearchToolRankingOptionsRanker.
- ResponsesFunctionCallItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesFunctionCallItem model.
- ResponsesFunctionCallItem(String, String, String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
-
Creates an instance of ResponsesFunctionCallItem class.
- ResponsesFunctionCallItemStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesFunctionCallItemStatus.
- ResponsesFunctionCallOutput - Class in com.azure.ai.openai.responses.models
-
The ResponsesFunctionCallOutput model.
- ResponsesFunctionCallOutput(String, String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
-
Creates an instance of ResponsesFunctionCallOutput class.
- ResponsesFunctionCallOutputStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesFunctionCallOutputStatus.
- ResponsesFunctionTool - Class in com.azure.ai.openai.responses.models
-
The ResponsesFunctionTool model.
- ResponsesFunctionTool(String, String, BinaryData, boolean) - Constructor for class com.azure.ai.openai.responses.models.ResponsesFunctionTool
-
Creates an instance of ResponsesFunctionTool class.
- ResponsesInputContentFile - Class in com.azure.ai.openai.responses.models
-
The ResponsesInputContentFile model.
- ResponsesInputContentFile() - Constructor for class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Creates an instance of ResponsesInputContentFile class.
- ResponsesInputContentImage - Class in com.azure.ai.openai.responses.models
-
The ResponsesInputContentImage model.
- ResponsesInputContentImage() - Constructor for class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Creates an instance of ResponsesInputContentImage class.
- ResponsesInputContentImageDetail - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesInputContentImageDetail.
- ResponsesInputContentText - Class in com.azure.ai.openai.responses.models
-
The ResponsesInputContentText model.
- ResponsesInputContentText(String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesInputContentText
-
Creates an instance of ResponsesInputContentText class.
- ResponsesInputItemList - Class in com.azure.ai.openai.responses.models
-
The ResponsesInputItemList model.
- ResponsesItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesItem model.
- ResponsesItem() - Constructor for class com.azure.ai.openai.responses.models.ResponsesItem
-
Creates an instance of ResponsesItem class.
- ResponsesItemReferenceItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesItemReferenceItem model.
- ResponsesItemReferenceItem() - Constructor for class com.azure.ai.openai.responses.models.ResponsesItemReferenceItem
-
Creates an instance of ResponsesItemReferenceItem class.
- ResponsesItemType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesItemType.
- ResponsesMessage - Class in com.azure.ai.openai.responses.models
-
A response message item, representing a role and content.
- ResponsesMessage() - Constructor for class com.azure.ai.openai.responses.models.ResponsesMessage
-
Creates an instance of ResponsesMessage class.
- ResponsesMessageRole - Enum in com.azure.ai.openai.responses.models
-
The collection of valid roles for responses message items.
- ResponsesMessageStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesMessageStatus.
- ResponsesOutputContentRefusal - Class in com.azure.ai.openai.responses.models
-
The ResponsesOutputContentRefusal model.
- ResponsesOutputContentRefusal(String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesOutputContentRefusal
-
Creates an instance of ResponsesOutputContentRefusal class.
- ResponsesOutputContentText - Class in com.azure.ai.openai.responses.models
-
The ResponsesOutputContentText model.
- ResponsesOutputContentText(String, List<ResponsesOutputTextAnnotation>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesOutputContentText
-
Creates an instance of ResponsesOutputContentText class.
- ResponsesOutputTextAnnotation - Class in com.azure.ai.openai.responses.models
-
The ResponsesOutputTextAnnotation model.
- ResponsesOutputTextAnnotation() - Constructor for class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotation
-
Creates an instance of ResponsesOutputTextAnnotation class.
- ResponsesOutputTextAnnotationFileCitation - Class in com.azure.ai.openai.responses.models
-
The ResponsesOutputTextAnnotationFileCitation model.
- ResponsesOutputTextAnnotationFileCitation(int, String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFileCitation
-
Creates an instance of ResponsesOutputTextAnnotationFileCitation class.
- ResponsesOutputTextAnnotationFilePath - Class in com.azure.ai.openai.responses.models
-
The ResponsesOutputTextAnnotationFilePath model.
- ResponsesOutputTextAnnotationFilePath(String, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath
-
Creates an instance of ResponsesOutputTextAnnotationFilePath class.
- ResponsesOutputTextAnnotationType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesOutputTextAnnotationType.
- ResponsesOutputTextAnnotationUrlCitation - Class in com.azure.ai.openai.responses.models
-
The ResponsesOutputTextAnnotationUrlCitation model.
- ResponsesOutputTextAnnotationUrlCitation(String, String, int, int) - Constructor for class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
-
Creates an instance of ResponsesOutputTextAnnotationUrlCitation class.
- ResponsesReasoningConfiguration - Class in com.azure.ai.openai.responses.models
-
**o-series models only** Configuration options for reasoning models.
- ResponsesReasoningConfiguration(ResponsesReasoningConfigurationEffort) - Constructor for class com.azure.ai.openai.responses.models.ResponsesReasoningConfiguration
-
Creates an instance of ResponsesReasoningConfiguration class.
- ResponsesReasoningConfigurationEffort - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesReasoningConfigurationEffort.
- ResponsesReasoningConfigurationGenerateSummary - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesReasoningConfigurationGenerateSummary.
- ResponsesReasoningItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesReasoningItem model.
- ResponsesReasoningItem(List<ResponsesReasoningItemSummaryElement>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesReasoningItem
-
Creates an instance of ResponsesReasoningItem class.
- ResponsesReasoningItemStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesReasoningItemStatus.
- ResponsesReasoningItemSummaryElement - Class in com.azure.ai.openai.responses.models
-
The ResponsesReasoningItemSummaryElement model.
- ResponsesReasoningItemSummaryElement() - Constructor for class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElement
-
Creates an instance of ResponsesReasoningItemSummaryElement class.
- ResponsesReasoningItemSummaryElementSummaryText - Class in com.azure.ai.openai.responses.models
-
The ResponsesReasoningItemSummaryElementSummaryText model.
- ResponsesReasoningItemSummaryElementSummaryText(String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElementSummaryText
-
Creates an instance of ResponsesReasoningItemSummaryElementSummaryText class.
- ResponsesReasoningItemSummaryType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesReasoningItemSummaryType.
- ResponsesResponse - Class in com.azure.ai.openai.responses.models
-
The ResponsesResponse model.
- ResponsesResponseIncompleteDetails - Class in com.azure.ai.openai.responses.models
-
The ResponsesResponseIncompleteDetails1 model.
- ResponsesResponseIncompleteDetailsReason - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesResponseIncompleteDetailsReason.
- ResponsesResponseStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesResponseStatus.
- ResponsesResponseStreamEventResponseWebSearchCallCompleted - Class in com.azure.ai.openai.responses.models
-
Emitted when a web search call is completed.
- ResponsesResponseStreamEventResponseWebSearchCallInProgress - Class in com.azure.ai.openai.responses.models
-
Emitted when a web search call is initiated.
- ResponsesResponseStreamEventResponseWebSearchCallSearching - Class in com.azure.ai.openai.responses.models
-
Emitted when a web search call is executing.
- ResponsesResponseUsage - Class in com.azure.ai.openai.responses.models
-
The ResponsesResponseUsage model.
- ResponsesResponseUsageOutputTokensDetails - Class in com.azure.ai.openai.responses.models
-
The ResponsesResponseUsageOutputTokensDetails model.
- ResponsesStreamEvent - Class in com.azure.ai.openai.responses.models
-
The ResponsesStreamEvent model.
- ResponsesStreamEvent() - Constructor for class com.azure.ai.openai.responses.models.ResponsesStreamEvent
-
Creates an instance of ResponsesStreamEvent class.
- ResponsesStreamEventCompleted - Class in com.azure.ai.openai.responses.models
-
Returned when a Response is done streaming.
- ResponsesStreamEventContentPartAdded - Class in com.azure.ai.openai.responses.models
-
Emitted when a new content part is added.
- ResponsesStreamEventContentPartDone - Class in com.azure.ai.openai.responses.models
-
Emitted when a content part is done.
- ResponsesStreamEventCreated - Class in com.azure.ai.openai.responses.models
-
Returned when a new Response is created.
- ResponsesStreamEventError - Class in com.azure.ai.openai.responses.models
-
Emitted when an error has occurred.
- ResponsesStreamEventFailed - Class in com.azure.ai.openai.responses.models
-
Emitted when in-progress response generation has failed.
- ResponsesStreamEventFileSearchCallCompleted - Class in com.azure.ai.openai.responses.models
-
Emitted when a file search call is completed (results found).
- ResponsesStreamEventFileSearchCallInProgress - Class in com.azure.ai.openai.responses.models
-
Emitted when a file search call is initiated.
- ResponsesStreamEventFileSearchCallSearching - Class in com.azure.ai.openai.responses.models
-
Emitted when a file search call has begun searching.
- ResponsesStreamEventFunctionCallArgumentsDelta - Class in com.azure.ai.openai.responses.models
-
Returned when the model-generated function call arguments are updated.
- ResponsesStreamEventFunctionCallArgumentsDone - Class in com.azure.ai.openai.responses.models
-
Returned when the model-generated function call arguments are done streaming.
- ResponsesStreamEventIncomplete - Class in com.azure.ai.openai.responses.models
-
Emitted when response generation has terminated in an incomplete status.
- ResponsesStreamEventInProgress - Class in com.azure.ai.openai.responses.models
-
Emitted when the response is in progress.
- ResponsesStreamEventOutputItemAdded - Class in com.azure.ai.openai.responses.models
-
Returned when a new output item is created during response generation.
- ResponsesStreamEventOutputItemDone - Class in com.azure.ai.openai.responses.models
-
Returned when an output item is done streaming.
- ResponsesStreamEventOutputTextAnnotationAdded - Class in com.azure.ai.openai.responses.models
-
Emitted when a new output text annotation is added.
- ResponsesStreamEventOutputTextDelta - Class in com.azure.ai.openai.responses.models
-
Emitted when the text value of a "text" content part is updated.
- ResponsesStreamEventOutputTextDone - Class in com.azure.ai.openai.responses.models
-
Emitted when the text value of a "text" content part is done streaming.
- ResponsesStreamEventRefusalDelta - Class in com.azure.ai.openai.responses.models
-
Emitted when an incremental delta update to refusal information is available.
- ResponsesStreamEventRefusalDone - Class in com.azure.ai.openai.responses.models
-
Emitted when a refusal output item is completed.
- ResponsesStreamEventType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesStreamEventType.
- ResponsesSystemMessage - Class in com.azure.ai.openai.responses.models
-
A message item with the `system` role.
- ResponsesSystemMessage(List<ResponsesContent>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesSystemMessage
-
Creates an instance of ResponsesSystemMessage class.
- ResponsesTextFormat - Class in com.azure.ai.openai.responses.models
-
The ResponsesTextFormat model.
- ResponsesTextFormat() - Constructor for class com.azure.ai.openai.responses.models.ResponsesTextFormat
-
Creates an instance of ResponsesTextFormat class.
- ResponsesTextFormatJsonObject - Class in com.azure.ai.openai.responses.models
-
The ResponsesTextFormatJsonObject model.
- ResponsesTextFormatJsonObject() - Constructor for class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonObject
-
Creates an instance of ResponsesTextFormatJsonObject class.
- ResponsesTextFormatJsonSchema - Class in com.azure.ai.openai.responses.models
-
The ResponsesTextFormatJsonSchema model.
- ResponsesTextFormatJsonSchema(String, BinaryData) - Constructor for class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Creates an instance of ResponsesTextFormatJsonSchema class.
- ResponsesTextFormatText - Class in com.azure.ai.openai.responses.models
-
The ResponsesTextFormatText model.
- ResponsesTextFormatText() - Constructor for class com.azure.ai.openai.responses.models.ResponsesTextFormatText
-
Creates an instance of ResponsesTextFormatText class.
- ResponsesTextFormatType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesTextFormatType.
- ResponsesTool - Class in com.azure.ai.openai.responses.models
-
The ResponsesTool model.
- ResponsesTool() - Constructor for class com.azure.ai.openai.responses.models.ResponsesTool
-
Creates an instance of ResponsesTool class.
- ResponsesToolChoiceObject - Class in com.azure.ai.openai.responses.models
-
The ResponsesToolChoiceObject model.
- ResponsesToolChoiceObject() - Constructor for class com.azure.ai.openai.responses.models.ResponsesToolChoiceObject
-
Creates an instance of ResponsesToolChoiceObject class.
- ResponsesToolChoiceObjectComputer - Class in com.azure.ai.openai.responses.models
-
The ResponsesToolChoiceObjectComputer model.
- ResponsesToolChoiceObjectComputer() - Constructor for class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectComputer
-
Creates an instance of ResponsesToolChoiceObjectComputer class.
- ResponsesToolChoiceObjectFileSearch - Class in com.azure.ai.openai.responses.models
-
The ResponsesToolChoiceObjectFileSearch model.
- ResponsesToolChoiceObjectFileSearch() - Constructor for class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFileSearch
-
Creates an instance of ResponsesToolChoiceObjectFileSearch class.
- ResponsesToolChoiceObjectFunction - Class in com.azure.ai.openai.responses.models
-
The ResponsesToolChoiceObjectFunction model.
- ResponsesToolChoiceObjectFunction(String) - Constructor for class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFunction
-
Creates an instance of ResponsesToolChoiceObjectFunction class.
- ResponsesToolChoiceObjectType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesToolChoiceObjectType.
- ResponsesToolChoiceObjectWebSearch - Class in com.azure.ai.openai.responses.models
-
The ResponsesToolChoiceObjectWebSearch model.
- ResponsesToolChoiceObjectWebSearch() - Constructor for class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectWebSearch
-
Creates an instance of ResponsesToolChoiceObjectWebSearch class.
- ResponsesToolChoiceOption - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesToolChoiceOption.
- ResponsesToolType - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesToolType.
- ResponsesUserMessage - Class in com.azure.ai.openai.responses.models
-
A message item with the `user` role.
- ResponsesUserMessage(List<ResponsesContent>) - Constructor for class com.azure.ai.openai.responses.models.ResponsesUserMessage
-
Creates an instance of ResponsesUserMessage class.
- ResponsesWebSearchApproximateLocation - Class in com.azure.ai.openai.responses.models
-
The ResponsesWebSearchApproximateLocation model.
- ResponsesWebSearchApproximateLocation() - Constructor for class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Creates an instance of ResponsesWebSearchApproximateLocation class.
- ResponsesWebSearchCallItem - Class in com.azure.ai.openai.responses.models
-
The ResponsesWebSearchCallItem model.
- ResponsesWebSearchCallItem() - Constructor for class com.azure.ai.openai.responses.models.ResponsesWebSearchCallItem
-
Creates an instance of ResponsesWebSearchCallItem class.
- ResponsesWebSearchCallItemStatus - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesWebSearchCallItemStatus.
- ResponsesWebSearchContextSize - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponsesWebSearchContextSize.
- ResponsesWebSearchLocation - Class in com.azure.ai.openai.responses.models
-
The ResponsesWebSearchLocation model.
- ResponsesWebSearchLocation() - Constructor for class com.azure.ai.openai.responses.models.ResponsesWebSearchLocation
-
Creates an instance of ResponsesWebSearchLocation class.
- ResponsesWebSearchTool - Class in com.azure.ai.openai.responses.models
-
The ResponsesWebSearchTool model.
- ResponsesWebSearchTool() - Constructor for class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Creates an instance of ResponsesWebSearchTool class.
- ResponseTextOptions - Class in com.azure.ai.openai.responses.models
-
The ResponseTextOptions model.
- ResponseTextOptions() - Constructor for class com.azure.ai.openai.responses.models.ResponseTextOptions
-
Creates an instance of ResponseTextOptions class.
- ResponseTruncation - Enum in com.azure.ai.openai.responses.models
-
Defines values for ResponseTruncation.
- retryOptions(RetryOptions) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
.
- retryOptions(RetryOptions) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
.
- retryPolicy(RetryPolicy) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- retryPolicy(RetryPolicy) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
Sets The retry policy that will attempt to retry failed requests, if applicable.
- RIGHT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Enum value right.
- RUNNING - Static variable in class com.azure.ai.openai.models.FileState
-
The operation has started to be processed.
S
- SAFE - Static variable in class com.azure.ai.openai.models.ContentFilterSeverity
-
Content may be related to violence, self-harm, sexual, or hate categories but the terms are used in general, journalistic, scientific, medical, and similar professional contexts, which are appropriate for most audiences.
- SCALE - Static variable in class com.azure.ai.openai.models.ServiceTier
-
Service tier option for scale.
- SCORE - Enum constant in enum com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
-
The document is filtered by original search score threshold defined by `strictness` configure.
- SCREENSHOT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value screenshot.
- SCROLL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value scroll.
- SEARCHING - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Enum value searching.
- SEARCHING - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Enum value searching.
- SEGMENT - Static variable in class com.azure.ai.openai.models.AudioTranscriptionTimestampGranularity
-
Indicates that responses should include timing and other information about each transcribed audio segment.
- SEMANTIC - Static variable in class com.azure.ai.openai.models.AzureSearchQueryType
-
Represents the semantic query parser for advanced semantic modeling.
- ServiceTier - Class in com.azure.ai.openai.models
-
The service tier used for processing the request.
- ServiceTier() - Constructor for class com.azure.ai.openai.models.ServiceTier
-
Deprecated.Use the
ServiceTier.fromString(String)factory method. - ServiceTierOptions - Class in com.azure.ai.openai.models
-
Specifies the latency tier to use for processing the request.
- ServiceTierOptions() - Constructor for class com.azure.ai.openai.models.ServiceTierOptions
-
Deprecated.Use the
ServiceTierOptions.fromString(String)factory method. - serviceVersion(OpenAIServiceVersion) - Method in class com.azure.ai.openai.OpenAIClientBuilder
-
Sets Service version.
- serviceVersion(AzureResponsesServiceVersion) - Method in class com.azure.ai.openai.responses.ResponsesClientBuilder
-
Sets Service version.
- setAllowPartialResult(Boolean) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- setAllowPartialResult(Boolean) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- setAllowPartialResult(Boolean) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- setAllowPartialResult(Boolean) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- setAllowPartialResult(Boolean) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Set the allowPartialResult property: If specified as true, the system will allow partial search results to be used and the request fails if all the queries fail.
- setApplicationName(String) - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Set the applicationName property: The name of the application.
- setAttributes(Map<String, BinaryData>) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Set the attributes property: The attributes property.
- setAudio(AudioOutputParameters) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the audio property: Parameters for audio output.
- 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.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.
- setAuthentication(OnYourDataUsernameAndPasswordAuthenticationOptions) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
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.
- setCity(String) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Set the city property: Free text input for the city of the user, e.g.
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Set the contentFieldsSeparator property: The content_fields_separator property.
- setContentFieldsSeparator(String) - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions
-
Set the contentFieldsSeparator property: The separator pattern that content fields should use.
- setContentType(String) - Method in class com.azure.ai.openai.models.DataFileDetails
-
Set the contentType property: The content-type of the file.
- setContentType(String) - Method in class com.azure.ai.openai.models.FileDetails
-
Set the contentType property: The content-type of the file.
- setCountry(String) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Set the country property: The two-letter [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1) of the user, e.g.
- 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.ChatCompletionsFunctionToolDefinitionFunction
-
Set the description property: A description of what the function does, used by the model to choose when and how to call the function.
- setDescription(String) - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Set the description property: A description of what the response format is for, used by the model to determine how to respond in the format.
- setDescription(String) - Method in class com.azure.ai.openai.models.FunctionDefinition
-
Set the description property: A description of what the function does.
- setDescription(String) - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Set the description property: The description property.
- 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.
- setDetail(ResponsesInputContentImageDetail) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Set the detail property: The detail property.
- 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.
- setDimensions(Integer) - Method in class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource
-
Set the dimensions property: The number of dimensions the 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.
- setEndUserId(String) - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Set the endUserId property: This identifier is the Microsoft Entra ID (formerly Azure Active Directory) user object ID used to authenticate end-users within the generative AI application.
- setEndUserTenantId(String) - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Set the endUserTenantId property: The Microsoft 365 tenant ID the end user belongs to.
- 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®.
- setFileData(String) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Set the fileData property: The file_data property.
- setFileId(String) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Set the fileId property: The file_id property.
- setFileId(String) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Set the fileId property: The file_id property.
- setFileId(String) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Set the fileId property: The file_id property.
- setFileId(String) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Set the fileId property: The file_id property.
- 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.
- setFilename(String) - Method in class com.azure.ai.openai.models.DataFileDetails
-
Set the filename property: The filename of the file.
- setFilename(String) - Method in class com.azure.ai.openai.models.FileDetails
-
Set the filename property: The filename of the file.
- setFilename(String) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Set the filename property: The filename property.
- setFilename(String) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
-
Set the filename property: The filename property.
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Set the filepathField property: The filepath_field property.
- 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.AzureSearchChatExtensionParameters
-
Set the filter property: Search filter.
- setFilters(BinaryData) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Set the filters property: The filters property.
- setFormat(ResponsesTextFormat) - Method in class com.azure.ai.openai.responses.models.ResponseTextOptions
-
Set the format property: The format property.
- 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.
- setGenerateSummary(ResponsesReasoningConfigurationGenerateSummary) - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningConfiguration
-
Set the generateSummary property: The generate_summary property.
- 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.
- setImageUrl(String) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
-
Set the imageUrl property: The image_url property.
- setImageUrl(String) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
-
Set the imageUrl property: The image_url property.
- 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.
- setInclude(List<CreateResponsesRequestIncludable>) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the include property: Specifies additional output data to include in the model response.
- setIncludeContexts(List<OnYourDataContextProperty>) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Set the includeContexts property: The included properties of the output context.
- setIncludeContexts(List<OnYourDataContextProperty>) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Set the includeContexts property: The included properties of the output context.
- setIncludeContexts(List<OnYourDataContextProperty>) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Set the includeContexts property: The included properties of the output context.
- setIncludeContexts(List<OnYourDataContextProperty>) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Set the includeContexts property: The included properties of the output context.
- setIncludeContexts(List<OnYourDataContextProperty>) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Set the includeContexts property: The included properties of the output context.
- setIncludeUsage(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionStreamOptions
-
Set the includeUsage property: If set, an additional chunk will be streamed before the `data: [DONE]` message.
- 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.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.MongoDBChatExtensionParameters
-
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.
- setInstructions(String) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the instructions property: The instructions property.
- 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.
- setMaxCompletionTokens(Integer) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the maxCompletionTokens property: An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
- setMaxNumResults(Integer) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Set the maxNumResults property: The max_num_results property.
- setMaxOutputTokens(Integer) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the maxOutputTokens property: An upper bound for the number of tokens that can be generated for a response, including visible output tokens and [reasoning tokens](/docs/guides/reasoning).
- setMaxSearchQueries(Integer) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
-
Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- setMaxSearchQueries(Integer) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
-
Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- setMaxSearchQueries(Integer) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
-
Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- setMaxSearchQueries(Integer) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
-
Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- setMaxSearchQueries(Integer) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
-
Set the maxSearchQueries property: The max number of rewritten queries should be send to search provider for one user message.
- setMaxTokens(Integer) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the maxTokens property: The maximum number of tokens allowed for the generated answer.
- setMaxTokens(Integer) - Method in class com.azure.ai.openai.models.CompletionsOptions
-
Set the maxTokens property: The maximum number of tokens to generate.
- setMd5(String) - Method in class com.azure.ai.openai.models.CompleteUploadRequest
-
Set the md5 property: The optional md5 checksum for the file contents to verify if the bytes uploaded matches what you expect.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.openai.models.BatchCreateRequest
-
Set the metadata property: A set of key-value pairs that can be attached to the batch.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the metadata property: Developer-defined tags and values used for filtering completions in the stored completions dashboard.
- setMetadata(Map<String, String>) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the metadata property: Set of 16 key-value pairs that can be attached to an object.
- setModalities(List<ChatCompletionModality>) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the modalities property: Output types that you would like the model to generate for this request.
- 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.ChatRequestDeveloperMessage
-
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.
- setParallelToolCalls(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the parallelToolCalls property: Whether to enable parallel function calling during tool use.
- setParallelToolCalls(Boolean) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the parallelToolCalls property: Specifies whether parallel tool calling should be enabled for this response.
- setParameters(BinaryData) - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
-
Set the parameters property: The parameters property.
- 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.
- setPrediction(PredictionContent) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the prediction property: Configuration for a Predicted Output, which can greatly improve response times when large parts of the model response are known ahead of time.
- 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.
- setPreviousResponseId(String) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the previousResponseId property: The unique ID of the previous response to the model.
- 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®.
- setRanker(ResponsesFileSearchToolRankingOptionsRanker) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
-
Set the ranker property: The ranker property.
- setRankingOptions(ResponsesFileSearchToolRankingOptions) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
-
Set the rankingOptions property: The ranking_options property.
- setReasoning(ResponsesReasoningConfiguration) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the reasoning property: The reasoning property.
- setReasoningEffort(ReasoningEffortValue) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the reasoningEffort property: This option is only valid for o1 models, Constrains effort on reasoning for reasoning models (see https://platform.openai.com/docs/guides/reasoning).
- setRefusal(String) - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
-
Set the refusal property: The refusal message by the assistant.
- setRegion(String) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Set the region property: Free text input for the region of the user, e.g.
- 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.
- setSchema(BinaryData) - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Set the schema property: The schema property.
- setScore(Double) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Set the score property: The score property.
- setScoreThreshold(Double) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
-
Set the scoreThreshold property: The score_threshold property.
- setSearchContextSize(ResponsesWebSearchContextSize) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Set the searchContextSize property: The search_context_size property.
- setSeed(Integer) - Method in class com.azure.ai.openai.models.CompletionsOptions
-
Set the seed property: If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same `seed` and parameters should return the same result.
- 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.
- setServiceTierOptions(ServiceTierOptions) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the
ServiceTierOptionsfor this request. - setSize(ImageSize) - Method in class com.azure.ai.openai.models.ImageGenerationOptions
-
Set the size property: The desired dimensions for generated images.
- setSourceIp(String) - Method in class com.azure.ai.openai.models.UserSecurityContext
-
Set the sourceIp property: Captures the original client's IP address, accepting both IPv4 and IPv6 formats.
- 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.
- setStore(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the store property: Whether or not to store the output of this chat completion request for use in our model distillation or evaluation products.
- setStore(Boolean) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the store property: The store property.
- setStrict(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
-
Set the strict property: Whether to enable strict schema adherence when generating the function call.
- setStrict(Boolean) - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
-
Set the strict property: Whether to enable strict schema adherence when generating the output.
- setStrict(Boolean) - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
-
Set the strict property: The strict property.
- 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.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.MongoDBChatExtensionParameters
-
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.
- setTemperature(Double) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the temperature property: What sampling temperature to use, between 0 and 2.
- setText(ResponseTextOptions) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the text property: The text property.
- setText(String) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
-
Set the text property: The text property.
- setTimestampGranularities(List<AudioTranscriptionTimestampGranularity>) - Method in class com.azure.ai.openai.models.AudioTranscriptionOptions
-
Set the timestampGranularities property: The timestamp granularities to populate for this transcription.
- setTimezone(String) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
-
Set the timezone property: The [IANA timezone](https://timeapi.io/documentation/iana-timezones) of the user, e.g.
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Set the titleField property: The title_field property.
- 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(ChatCompletionsToolSelection) - 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.
- setToolChoice(BinaryData) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the toolChoice property: How the model should select which tool (or tools) to use when generating a 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.
- setTools(List<ResponsesTool>) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the tools property: The tools to use to generate a response.
- 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.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.MongoDBChatExtensionParameters
-
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.
- setTopP(Double) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the topP property: An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
- setTruncation(ResponseTruncation) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the truncation property: The truncation strategy to use for the model response
- 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.MongoDBChatExtensionParametersFieldsMapping
-
Set the urlField property: The url_field property.
- 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.
- setUser(String) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
-
Set the user property: A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
- setUserLocation(ResponsesWebSearchLocation) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
-
Set the userLocation property: The user_location property.
- setUserSecurityContext(UserSecurityContext) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
-
Set the userSecurityContext property: The security context identifies and authenticates users and applications in your multi-tenant AI system, helping security teams investigate and mitigate incidents.
- 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.
- Streaming chat completions - Search tag in Overview
- Section
- Streaming legacy completions - Search tag in Overview
- Section
- Structured Outputs - Search tag in Overview
- Section
- SUMMARY_TEXT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryType
-
Enum value summary_text.
- Support for non-Azure OpenAI - Search tag in Overview
- Section
- SYSTEM - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Enum value system.
- SYSTEM - Static variable in class com.azure.ai.openai.models.ChatRole
-
The role that instructs or sets the behavior of the assistant.
- SYSTEM_ASSIGNED_MANAGED_IDENTITY - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via system-assigned managed identity.
T
- TEXT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
-
Enum value text.
- 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.
- TEXT - Static variable in class com.azure.ai.openai.models.ChatCompletionModality
-
The model is to generate text output.
- TEXT_EVENT_STREAM - Enum constant in enum com.azure.ai.openai.responses.models.CreateResponseRequestAccept
-
Enum value text/event-stream.
- Text completions with images - Search tag in Overview
- Section
- Text embeddings - Search tag in Overview
- Section
- Text To Speech - Search tag in Overview
- Section
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioOutputParameters
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioResponseData
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioTranscription
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioTranscriptionSegment
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioTranscriptionWord
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioTranslation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AudioTranslationSegment
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatEnhancementConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatEnhancements
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatExtensionConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatExtensionDataSourceResponseCitation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatExtensionRetrievedDocument
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatExtensionsMessageContext
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatGroundingEnhancementConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureChatOCREnhancementConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureCosmosDBChatExtensionParameters
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureCosmosDBFieldMappingOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureGroundingEnhancement
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementCoordinatePoint
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLine
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureGroundingEnhancementLineSpan
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureSearchChatExtensionParameters
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.AzureSearchIndexFieldMappingOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.Batch
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.BatchCreateRequest
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.BatchErrorDatum
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.BatchErrorList
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.BatchRequestCounts
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatChoice
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatChoiceLogProbabilityInfo
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolDefinitionFunction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsFunctionToolSelection
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsJsonResponseFormat
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormat
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsJsonSchemaResponseFormatJsonSchema
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsNamedFunctionToolSelection
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsNamedToolSelection
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsResponseFormat
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsTextResponseFormat
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsToolCall
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionsToolDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatCompletionStreamOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatFinishDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatMessageAudioContentItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatMessageContentItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatMessageImageContentItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatMessageImageUrl
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatMessageRefusalContentItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatMessageTextContentItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestAssistantMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestDeveloperMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestFunctionMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestSystemMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestToolMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatRequestUserMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatResponseMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityInfo
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ChatTokenLogProbabilityResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.Choice
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CompleteUploadRequest
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.Completions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CompletionsLogProbabilityModel
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CompletionsOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CompletionsUsage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CompletionsUsageCompletionTokensDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CompletionsUsagePromptTokensDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterBlocklistIdResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterCitedDetectionResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpan
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterCompletionTextSpanResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterDetailedResults
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterDetectionResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterResultDetailsForPrompt
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterResultsForChoice
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ContentFilterResultsForPrompt
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.CreateUploadRequest
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ElasticsearchChatExtensionParameters
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ElasticsearchIndexFieldMappingOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.EmbeddingItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.Embeddings
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.EmbeddingsOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.EmbeddingsUsage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.FileDeletionStatus
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.FunctionCall
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.FunctionDefinition
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.FunctionName
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ImageGenerationContentFilterResults
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ImageGenerationData
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ImageGenerationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ImageGenerationPromptFilterResults
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.ImageGenerations
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.InputAudioContent
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.MaxTokensFinishDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParameters
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.MongoDBChatExtensionParametersFieldsMapping
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataAccessTokenAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataApiKeyAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataConnectionStringAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataDeploymentNameVectorizationSource
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataEncodedApiKeyAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataEndpointVectorizationSource
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataIntegratedVectorizationSource
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataKeyAndKeyIdAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataModelIdVectorizationSource
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataSystemAssignedManagedIdentityAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataUserAssignedManagedIdentityAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataUsernameAndPasswordAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataVectorizationSource
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchAccessTokenAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchApiKeyAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.OpenAIFile
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.PineconeChatExtensionConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.PineconeChatExtensionParameters
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.PineconeFieldMappingOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.PredictionContent
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.SpeechGenerationOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.StopFinishDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.Upload
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.UploadPart
- toJson(JsonWriter) - Method in class com.azure.ai.openai.models.UserSecurityContext
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.CreateResponsesRequest
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.DeleteResponseResponse
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesAssistantMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallClickAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDoubleClickAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallDragActionPath
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallItemSafetyCheck
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallKeyPressAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallMoveAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutput
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemScreenshot
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScreenshotAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallScrollAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallTypeAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerCallWaitAction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesComputerTool
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesContent
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesDeveloperMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesError
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemResult
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchTool
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptions
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionCallOutput
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesFunctionTool
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentFile
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentImage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesInputContentText
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesInputItemList
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesItemReferenceItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentRefusal
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesOutputContentText
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFileCitation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationFilePath
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationUrlCitation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningConfiguration
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElement
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryElementSummaryText
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponse
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallCompleted
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallInProgress
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponseStreamEventResponseWebSearchCallSearching
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesResponseUsageOutputTokensDetails
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEvent
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCompleted
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartAdded
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventContentPartDone
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventCreated
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventError
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFailed
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallCompleted
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallInProgress
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFileSearchCallSearching
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDelta
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventFunctionCallArgumentsDone
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventIncomplete
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventInProgress
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemAdded
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputItemDone
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextAnnotationAdded
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDelta
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventOutputTextDone
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDelta
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesStreamEventRefusalDone
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesSystemMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormat
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonObject
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatJsonSchema
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesTextFormatText
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesTool
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObject
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectComputer
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFileSearch
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectFunction
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectWebSearch
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesUserMessage
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchApproximateLocation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchCallItem
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchLocation
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponsesWebSearchTool
- toJson(JsonWriter) - Method in class com.azure.ai.openai.responses.models.ResponseTextOptions
- 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.
- Tool calls - Search tag in Overview
- Section
- toString() - Method in enum com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
- toString() - Method in enum com.azure.ai.openai.models.UploadObject
- toString() - Method in enum com.azure.ai.openai.responses.models.CreateResponseRequestAccept
- toString() - Method in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
- toString() - Method in enum com.azure.ai.openai.responses.models.ListInputItemsRequestOrder
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutputType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesContentType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptionsRanker
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesItemType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationGenerateSummary
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetailsReason
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesToolType
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
- toString() - Method in enum com.azure.ai.openai.responses.models.ResponseTruncation
- 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.
- Troubleshooting - Search tag in Overview
- Section
- TYPE - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value type.
U
- UBUNTU - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Enum value ubuntu.
- Upload - Class in com.azure.ai.openai.models
-
The Upload object can accept byte chunks in the form of Parts.
- UPLOAD - Enum constant in enum com.azure.ai.openai.models.UploadObject
-
Enum value upload.
- UPLOADED - Static variable in class com.azure.ai.openai.models.FileState
-
The file has been uploaded but it's not yet processed.
- uploadFile(FileDetails, FilePurpose) - Method in class com.azure.ai.openai.OpenAIAsyncClient
-
Uploads a file for use by other operations.
- uploadFile(FileDetails, FilePurpose) - Method in class com.azure.ai.openai.OpenAIClient
-
Uploads a file for use by other operations.
- Upload large files in multiple parts - Search tag in Overview
- Section
- UploadObject - Enum in com.azure.ai.openai.models
-
Defines values for UploadObject.
- UploadPart - Class in com.azure.ai.openai.models
-
The upload Part represents a chunk of bytes we can add to an Upload object.
- UploadPurpose - Class in com.azure.ai.openai.models
-
Defines values for UploadPurpose.
- UploadPurpose() - Constructor for class com.azure.ai.openai.models.UploadPurpose
-
Deprecated.Use the
UploadPurpose.fromString(String)factory method. - UploadStatus - Class in com.azure.ai.openai.models
-
Defines values for UploadStatus.
- UploadStatus() - Constructor for class com.azure.ai.openai.models.UploadStatus
-
Deprecated.Use the
UploadStatus.fromString(String)factory method. - 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.
- URL_CITATION - Enum constant in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
-
Enum value url_citation.
- USER - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Enum value user.
- USER - Static variable in class com.azure.ai.openai.models.ChatRole
-
The role that provides input for chat completions.
- USER_ASSIGNED_MANAGED_IDENTITY - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via user-assigned managed identity.
- USERNAME_AND_PASSWORD - Static variable in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Authentication via username and password.
- UserSecurityContext - Class in com.azure.ai.openai.models
-
User security context contains several parameters that describe the AI application itself, and the end user that interacts with the AI application.
- UserSecurityContext() - Constructor for class com.azure.ai.openai.models.UserSecurityContext
-
Creates an instance of UserSecurityContext class.
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_01 - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-02-01.
- V2024_02_15_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-02-15-preview.
- V2024_02_15_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
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.
- V2024_04_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-04-01-preview.
- V2024_04_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-04-01-preview.
- V2024_05_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-05-01-preview.
- V2024_06_01 - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-06-01.
- V2024_06_01 - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-06-01.
- V2024_07_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-07-01-preview.
- V2024_08_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-08-01-preview.
- V2024_08_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-08-01-preview.
- V2024_09_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-09-01-preview.
- V2024_09_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-09-01-preview.
- V2024_10_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2024-10-01-preview.
- V2024_10_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-10-01-preview.
- V2024_10_21 - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-10-21.
- V2024_12_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2024-12-01-preview.
- V2025_01_01_PREVIEW - Enum constant in enum com.azure.ai.openai.OpenAIServiceVersion
-
Enum value 2025-01-01-preview.
- V2025_01_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2025-01-01-preview.
- V2025_03_01_PREVIEW - Enum constant in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Enum value 2025-03-01-preview.
- VALIDATING - Static variable in class com.azure.ai.openai.models.BatchStatus
-
The input file is being validated before the batch can begin.
- valueOf(String) - Static method in enum com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.models.UploadObject
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.OpenAIServiceVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.CreateResponseRequestAccept
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ListInputItemsRequestOrder
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutputType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptionsRanker
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationGenerateSummary
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetailsReason
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.azure.ai.openai.responses.models.ResponseTruncation
-
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.AudioTranscriptionTimestampGranularity
-
Gets known AudioTranscriptionTimestampGranularity values.
- values() - Static method in class com.azure.ai.openai.models.AudioTranslationFormat
-
Gets known AudioTranslationFormat values.
- values() - Static method in enum com.azure.ai.openai.models.AzureChatExtensionRetrieveDocumentFilterReason
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.ai.openai.models.AzureChatExtensionType
-
Gets known AzureChatExtensionType 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.BatchStatus
-
Gets known BatchStatus values.
- values() - Static method in class com.azure.ai.openai.models.ChatCompletionModality
-
Gets known ChatCompletionModality 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.CreateUploadRequestPurpose
-
Gets known CreateUploadRequestPurpose 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.FilePurpose
-
Gets known FilePurpose values.
- values() - Static method in class com.azure.ai.openai.models.FileState
-
Gets known FileState 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.InputAudioFormat
-
Gets known InputAudioFormat values.
- values() - Static method in class com.azure.ai.openai.models.OnYourDataAuthenticationType
-
Gets known OnYourDataAuthenticationType values.
- values() - Static method in class com.azure.ai.openai.models.OnYourDataContextProperty
-
Gets known OnYourDataContextProperty values.
- values() - Static method in class com.azure.ai.openai.models.OnYourDataVectorizationSourceType
-
Gets known OnYourDataVectorizationSourceType values.
- values() - Static method in class com.azure.ai.openai.models.OnYourDataVectorSearchAuthenticationType
-
Gets known OnYourDataVectorSearchAuthenticationType values.
- values() - Static method in class com.azure.ai.openai.models.OutputAudioFormat
-
Gets known OutputAudioFormat values.
- values() - Static method in class com.azure.ai.openai.models.PredictionContentType
-
Gets known PredictionContentType values.
- values() - Static method in class com.azure.ai.openai.models.ReasoningEffortValue
-
Gets known ReasoningEffortValue values.
- values() - Static method in class com.azure.ai.openai.models.ServiceTier
-
Get known ServiceTier values.
- values() - Static method in class com.azure.ai.openai.models.ServiceTierOptions
-
Get known ServiceTierOptions 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.models.UploadObject
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.ai.openai.models.UploadPurpose
-
Gets known UploadPurpose values.
- values() - Static method in class com.azure.ai.openai.models.UploadStatus
-
Gets known UploadStatus 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.
- values() - Static method in enum com.azure.ai.openai.responses.AzureResponsesServiceVersion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.CreateResponseRequestAccept
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.CreateResponsesRequestIncludable
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in class com.azure.ai.openai.responses.models.CreateResponsesRequestModel
-
Gets known CreateResponsesRequestModel values.
- values() - Static method in enum com.azure.ai.openai.responses.models.ListInputItemsRequestOrder
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponseOutputTextAnnotationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallItemStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemOutputType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerCallOutputItemStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesContentType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchCallItemStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesFileSearchToolRankingOptionsRanker
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallItemStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesFunctionCallOutputStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesInputContentImageDetail
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesMessageRole
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesMessageStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesOutputTextAnnotationType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationEffort
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningConfigurationGenerateSummary
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesReasoningItemSummaryType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesResponseIncompleteDetailsReason
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesResponseStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesStreamEventType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesTextFormatType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceOption
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchCallItemStatus
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponsesWebSearchContextSize
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.azure.ai.openai.responses.models.ResponseTruncation
-
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.
- VISION - Static variable in class com.azure.ai.openai.models.CreateUploadRequestPurpose
-
Static value vision for CreateUploadRequestPurpose.
- VISION - Static variable in class com.azure.ai.openai.models.FilePurpose
-
Indicates a file is used as input to a vision operation.
- VISION - Static variable in class com.azure.ai.openai.models.UploadPurpose
-
Static value vision for UploadPurpose.
- 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.
W
- WAIT - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallActionType
-
Enum value wait.
- WAV - Static variable in class com.azure.ai.openai.models.InputAudioFormat
-
Specifies that the audio data is in the WAV format.
- WAV - Static variable in class com.azure.ai.openai.models.OutputAudioFormat
-
The output audio format is WAV.
- WAV - Static variable in class com.azure.ai.openai.models.SpeechGenerationResponseFormat
-
Use uncompressed WAV as the audio output format, suitable for low-latency applications to avoid decoding overhead.
- WEB_SEARCH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolChoiceObjectType
-
Enum value web_search_preview.
- WEB_SEARCH - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesToolType
-
Enum value web_search_preview.
- WEB_SEARCH_CALL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesItemType
-
Enum value web_search_call.
- WHEEL - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerCallClickButtonType
-
Enum value wheel.
- WINDOWS - Enum constant in enum com.azure.ai.openai.responses.models.ResponsesComputerToolEnvironment
-
Enum value windows.
- WORD - Static variable in class com.azure.ai.openai.models.AudioTranscriptionTimestampGranularity
-
Indicates that responses should include timing information about each transcribed word.
All Classes and Interfaces|All Packages
AudioTaskLabel.fromString(String)factory method.