Index (Azure SDK for Java Reference Documentation)

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

A

Adding the package to your product - Search tag in Overview: Section
addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
addPolicy(HttpPipelinePolicy) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
ASSISTANT - Static variable in class com.azure.ai.inference.models.ChatRole: The role that provides responses to system-instructed, user-prompted input.
AUDIO_GENERATION - Static variable in class com.azure.ai.inference.models.ModelType: A text-to-audio generative model.
Authentication - Search tag in Overview: Section
AUTO - Static variable in class com.azure.ai.inference.models.ChatCompletionsToolChoicePreset: 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.inference.models.ChatMessageImageDetailLevel: Specifies that the model should determine which detail level to apply using heuristics like image size.
Azure AI Inference client library for Java - Search tag in Overview: Section

B

BASE64 - Static variable in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Base64.
BINARY - Static variable in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Binary.
buildAsyncClient() - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: Builds an instance of ChatCompletionsAsyncClient class.
buildAsyncClient() - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: Builds an instance of EmbeddingsAsyncClient class.
buildAsyncClient() - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: Builds an instance of ImageEmbeddingsAsyncClient class.
buildClient() - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: Builds an instance of ChatCompletionsClient class.
buildClient() - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: Builds an instance of EmbeddingsClient class.
buildClient() - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: Builds an instance of ImageEmbeddingsClient class.

C

CHAT_COMPLETION - Static variable in class com.azure.ai.inference.models.ModelType: A model capable of taking chat-formatted messages and generate responses.
ChatChoice - Class in com.azure.ai.inference.models: The representation of a single prompt completion as part of an overall chat completions request.
ChatCompletions - Class in com.azure.ai.inference.models: Representation of the response data from a chat completions request.
Chat completions - Search tag in Overview: Section
ChatCompletionsAsyncClient - Class in com.azure.ai.inference: Initializes a new instance of the asynchronous ChatCompletionsClient type.
ChatCompletionsClient - Class in com.azure.ai.inference: Initializes a new instance of the synchronous ChatCompletionsClient type.
ChatCompletionsClientBuilder - Class in com.azure.ai.inference: A builder for creating a new instance of the ChatCompletionsClient type.
ChatCompletionsClientBuilder() - Constructor for class com.azure.ai.inference.ChatCompletionsClientBuilder: Create an instance of the ChatCompletionsClientBuilder.
ChatCompletionsFunctionToolCall - Class in com.azure.ai.inference.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.inference.models.ChatCompletionsFunctionToolCall: Creates an instance of ChatCompletionsFunctionToolCall class.
ChatCompletionsFunctionToolDefinition - Class in com.azure.ai.inference.models: The definition information for a chat completions function tool that can call a function in response to a tool call.
ChatCompletionsFunctionToolDefinition(FunctionDefinition) - Constructor for class com.azure.ai.inference.models.ChatCompletionsFunctionToolDefinition: Creates an instance of ChatCompletionsFunctionToolDefinition class.
ChatCompletionsNamedToolChoice - Class in com.azure.ai.inference.models: A tool selection of a specific, named function tool that will limit chat completions to using the named function.
ChatCompletionsNamedToolChoice(ChatCompletionsNamedToolChoiceFunction) - Constructor for class com.azure.ai.inference.models.ChatCompletionsNamedToolChoice: Creates an instance of ChatCompletionsNamedToolChoice class.
ChatCompletionsNamedToolChoiceFunction - Class in com.azure.ai.inference.models: A tool selection of a specific, named function tool that will limit chat completions to using the named function.
ChatCompletionsNamedToolChoiceFunction(String) - Constructor for class com.azure.ai.inference.models.ChatCompletionsNamedToolChoiceFunction: Creates an instance of ChatCompletionsNamedToolChoiceFunction class.
ChatCompletionsOptions - Class in com.azure.ai.inference.models: The ChatCompletionsOptions model.
ChatCompletionsOptions(List<ChatRequestMessage>) - Constructor for class com.azure.ai.inference.models.ChatCompletionsOptions: Creates an instance of ChatCompletionsOptions class.
ChatCompletionsResponseFormat - Class in com.azure.ai.inference.models: Represents the format that the model must output.
ChatCompletionsResponseFormat() - Constructor for class com.azure.ai.inference.models.ChatCompletionsResponseFormat: Creates an instance of ChatCompletionsResponseFormat class.
ChatCompletionsResponseFormatJsonObject - Class in com.azure.ai.inference.models: A response format for Chat Completions that restricts responses to emitting valid JSON objects.
ChatCompletionsResponseFormatJsonObject() - Constructor for class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonObject: Creates an instance of ChatCompletionsResponseFormatJsonObject class.
ChatCompletionsResponseFormatJsonSchema - Class in com.azure.ai.inference.models: A response format for Chat Completions that restricts responses to emitting valid JSON objects, with a JSON schema specified by the caller.
ChatCompletionsResponseFormatJsonSchema(ChatCompletionsResponseFormatJsonSchemaDefinition) - Constructor for class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchema: Creates an instance of ChatCompletionsResponseFormatJsonSchema class.
ChatCompletionsResponseFormatJsonSchemaDefinition - Class in com.azure.ai.inference.models: Defines the response format for chat completions as JSON with a given schema.
ChatCompletionsResponseFormatJsonSchemaDefinition(String, Map<String, BinaryData>) - Constructor for class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Creates an instance of ChatCompletionsResponseFormatJsonSchemaDefinition class.
ChatCompletionsResponseFormatText - Class in com.azure.ai.inference.models: A response format for Chat Completions that emits text responses.
ChatCompletionsResponseFormatText() - Constructor for class com.azure.ai.inference.models.ChatCompletionsResponseFormatText: Creates an instance of ChatCompletionsResponseFormatText class.
ChatCompletionsToolCall - Class in com.azure.ai.inference.models: A function tool call requested by the AI model.
ChatCompletionsToolCall(String, FunctionCall) - Constructor for class com.azure.ai.inference.models.ChatCompletionsToolCall: Creates an instance of ChatCompletionsToolCall class.
ChatCompletionsToolChoicePreset - Class in com.azure.ai.inference.models: Represents a generic policy for how a chat completions tool may be selected.
ChatCompletionsToolChoicePreset() - Constructor for class com.azure.ai.inference.models.ChatCompletionsToolChoicePreset: Deprecated.
Use the ChatCompletionsToolChoicePreset.fromString(String) factory method.
ChatCompletionsToolDefinition - Class in com.azure.ai.inference.models: The definition of a chat completions tool that can call a function.
ChatCompletionsToolDefinition(FunctionDefinition) - Constructor for class com.azure.ai.inference.models.ChatCompletionsToolDefinition: Creates an instance of ChatCompletionsToolDefinition class.
ChatMessageContentItem - Class in com.azure.ai.inference.models: An abstract representation of a structured content item within a chat message.
ChatMessageContentItem() - Constructor for class com.azure.ai.inference.models.ChatMessageContentItem: Creates an instance of ChatMessageContentItem class.
ChatMessageImageContentItem - Class in com.azure.ai.inference.models: A structured chat content item containing an image reference.
ChatMessageImageContentItem(ChatMessageImageUrl) - Constructor for class com.azure.ai.inference.models.ChatMessageImageContentItem: Creates an instance of ChatMessageImageContentItem class.
ChatMessageImageContentItem(Path, String) - Constructor for class com.azure.ai.inference.models.ChatMessageImageContentItem: Creates an instance of ChatMessageImageContentItem class.
ChatMessageImageDetailLevel - Class in com.azure.ai.inference.models: A representation of the possible image detail levels for image-based chat completions message content.
ChatMessageImageDetailLevel() - Constructor for class com.azure.ai.inference.models.ChatMessageImageDetailLevel: Deprecated.
Use the ChatMessageImageDetailLevel.fromString(String) factory method.
ChatMessageImageUrl - Class in com.azure.ai.inference.models: An internet location from which the model may retrieve an image.
ChatMessageImageUrl(String) - Constructor for class com.azure.ai.inference.models.ChatMessageImageUrl: Creates an instance of ChatMessageImageUrl class.
ChatMessageTextContentItem - Class in com.azure.ai.inference.models: A structured chat content item containing plain text.
ChatMessageTextContentItem(String) - Constructor for class com.azure.ai.inference.models.ChatMessageTextContentItem: Creates an instance of ChatMessageTextContentItem class.
ChatRequestAssistantMessage - Class in com.azure.ai.inference.models: A request chat message representing response or action from the assistant.
ChatRequestAssistantMessage() - Constructor for class com.azure.ai.inference.models.ChatRequestAssistantMessage: Creates an instance of ChatRequestAssistantMessage class.
ChatRequestAssistantMessage(String) - Constructor for class com.azure.ai.inference.models.ChatRequestAssistantMessage: Creates an instance of ChatRequestAssistantMessage class.
ChatRequestDeveloperMessage - Class in com.azure.ai.inference.models: A request chat message containing developer instructions that influence how the model will generate a chat completions response.
ChatRequestDeveloperMessage(String) - Constructor for class com.azure.ai.inference.models.ChatRequestDeveloperMessage: Creates an instance of ChatRequestDeveloperMessage class.
ChatRequestMessage - Class in com.azure.ai.inference.models: An abstract representation of a chat message as provided in a request.
ChatRequestMessage() - Constructor for class com.azure.ai.inference.models.ChatRequestMessage: Creates an instance of ChatRequestMessage class.
ChatRequestSystemMessage - Class in com.azure.ai.inference.models: A request chat message containing system instructions that influence how the model will generate a chat completions response.
ChatRequestSystemMessage(String) - Constructor for class com.azure.ai.inference.models.ChatRequestSystemMessage: Creates an instance of ChatRequestSystemMessage class.
ChatRequestToolMessage - Class in com.azure.ai.inference.models: A request chat message representing requested output from a configured tool.
ChatRequestToolMessage(String) - Constructor for class com.azure.ai.inference.models.ChatRequestToolMessage: Creates an instance of ChatRequestToolMessage class.
ChatRequestUserMessage - Class in com.azure.ai.inference.models: A request chat message representing user input to the assistant.
ChatRequestUserMessage(BinaryData) - Constructor for class com.azure.ai.inference.models.ChatRequestUserMessage: Creates an instance of ChatRequestUserMessage class.
ChatRequestUserMessage(String) - Constructor for class com.azure.ai.inference.models.ChatRequestUserMessage: Creates an instance of ChatRequestUserMessage class.
ChatResponseMessage - Class in com.azure.ai.inference.models: A representation of a chat message as received in a response.
ChatRole - Class in com.azure.ai.inference.models: A description of the intended purpose of a message within a chat completions interaction.
ChatRole() - Constructor for class com.azure.ai.inference.models.ChatRole: Deprecated.
Use the ChatRole.fromString(String) factory method.
Chat with image file - Search tag in Overview: Section
Chat with image URL - Search tag in Overview: Section
clientOptions(ClientOptions) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
clientOptions(ClientOptions) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
clientOptions(ClientOptions) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
com.azure.ai.inference - package com.azure.ai.inference: Package containing the classes for Model.
com.azure.ai.inference.models - package com.azure.ai.inference.models: Package containing the data models for Model.
complete(ChatCompletionsOptions) - Method in class com.azure.ai.inference.ChatCompletionsAsyncClient: Gets chat completions for the provided chat messages.
complete(ChatCompletionsOptions) - Method in class com.azure.ai.inference.ChatCompletionsClient: Gets chat completions for the provided chat messages.
complete(String) - Method in class com.azure.ai.inference.ChatCompletionsAsyncClient: Gets completions for the provided input prompt.
complete(String) - Method in class com.azure.ai.inference.ChatCompletionsClient: Gets completions for the provided input prompt.
completeStream(ChatCompletionsOptions) - Method in class com.azure.ai.inference.ChatCompletionsAsyncClient: Gets chat completions for the provided chat messages.
completeStream(ChatCompletionsOptions) - Method in class com.azure.ai.inference.ChatCompletionsClient: Gets chat completions for the provided chat messages in streaming mode.
completeWithResponse(BinaryData, RequestOptions) - Method in class com.azure.ai.inference.ChatCompletionsClient: Gets chat completions for the provided chat messages.
CompletionsFinishReason - Class in com.azure.ai.inference.models: Representation of the manner in which a completions response concluded.
CompletionsFinishReason() - Constructor for class com.azure.ai.inference.models.CompletionsFinishReason: Deprecated.
Use the CompletionsFinishReason.fromString(String) factory method.
CompletionsUsage - Class in com.azure.ai.inference.models: Representation of the token counts processed for a completions request.
configuration(Configuration) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
configuration(Configuration) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
configuration(Configuration) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
CONTENT_FILTERED - Static variable in class com.azure.ai.inference.models.CompletionsFinishReason: Completions generated a response that was identified as potentially sensitive per content moderation policies.
Contributing - Search tag in Overview: Section
Create a Chat Completions client with key credential - Search tag in Overview: Section
Create a client with Azure Active Directory credential - Search tag in Overview: Section
credential(KeyCredential) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
credential(KeyCredential) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
credential(KeyCredential) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
credential(TokenCredential) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
credential(TokenCredential) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
credential(TokenCredential) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .

D

Default HTTP Client - Search tag in Overview: Section
Default SSL library - Search tag in Overview: Section
DEVELOPER - Static variable in class com.azure.ai.inference.models.ChatRole: The role that instructs or sets the behavior of the assistant.
DOCUMENT - Static variable in class com.azure.ai.inference.models.EmbeddingInputType: Indicates the input represents a document that is stored in a vector database.
Documentation - Search tag in Overview: Section
DROP - Static variable in class com.azure.ai.inference.models.ExtraParameters: The service will ignore (drop) extra parameters in the request payload.

E

embed(List<ImageEmbeddingInput>) - Method in class com.azure.ai.inference.ImageEmbeddingsAsyncClient: Return the embedding vectors for given text prompts.
embed(List<ImageEmbeddingInput>) - Method in class com.azure.ai.inference.ImageEmbeddingsClient: Return the embedding vectors for given text prompts.
embed(List<String>) - Method in class com.azure.ai.inference.EmbeddingsAsyncClient: Return the embedding vectors for given text prompts.
embed(List<String>) - Method in class com.azure.ai.inference.EmbeddingsClient: Return the embedding vectors for given text prompts.
embed(List<String>, Integer, EmbeddingEncodingFormat, EmbeddingInputType, String, ExtraParameters) - Method in class com.azure.ai.inference.EmbeddingsAsyncClient: Return the embedding vectors for given text prompts.
embed(List<String>, Integer, EmbeddingEncodingFormat, EmbeddingInputType, String, ExtraParameters) - Method in class com.azure.ai.inference.EmbeddingsClient: Return the embedding vectors for given text prompts.
EmbeddingEncodingFormat - Class in com.azure.ai.inference.models: The format of the embeddings result.
EmbeddingEncodingFormat() - Constructor for class com.azure.ai.inference.models.EmbeddingEncodingFormat: Deprecated.
Use the EmbeddingEncodingFormat.fromString(String) factory method.
EmbeddingInput - Class in com.azure.ai.inference.models: Represents an image with optional text.
EmbeddingInput(String) - Constructor for class com.azure.ai.inference.models.EmbeddingInput: Creates an instance of EmbeddingInput class.
EmbeddingInputType - Class in com.azure.ai.inference.models: Represents the input types used for embedding search.
EmbeddingInputType() - Constructor for class com.azure.ai.inference.models.EmbeddingInputType: Deprecated.
Use the EmbeddingInputType.fromString(String) factory method.
EmbeddingItem - Class in com.azure.ai.inference.models: Representation of a single embeddings relatedness comparison.
EMBEDDINGS - Static variable in class com.azure.ai.inference.models.ModelType: A model capable of generating embeddings from a text.
EmbeddingsAsyncClient - Class in com.azure.ai.inference: Initializes a new instance of the asynchronous EmbeddingsClient type.
EmbeddingsClient - Class in com.azure.ai.inference: Initializes a new instance of the synchronous EmbeddingsClient type.
EmbeddingsClientBuilder - Class in com.azure.ai.inference: A builder for creating a new instance of the EmbeddingsClient type.
EmbeddingsClientBuilder() - Constructor for class com.azure.ai.inference.EmbeddingsClientBuilder: Create an instance of the EmbeddingsClientBuilder.
EmbeddingsResult - Class in com.azure.ai.inference.models: Representation of the response data from an embeddings request.
EmbeddingsUsage - Class in com.azure.ai.inference.models: Measurement of the amount of tokens used in this request and response.
embedWithResponse(List<String>) - Method in class com.azure.ai.inference.EmbeddingsAsyncClient: Return the embedding vectors for given text prompts.
embedWithResponse(List<String>) - Method in class com.azure.ai.inference.EmbeddingsClient: Return the embedding vectors for given text prompts.
embedWithResponse(List<String>, Integer, EmbeddingEncodingFormat, EmbeddingInputType, String, ExtraParameters) - Method in class com.azure.ai.inference.EmbeddingsAsyncClient: Return the embedding vectors for given text prompts.
embedWithResponse(List<String>, Integer, EmbeddingEncodingFormat, EmbeddingInputType, String, ExtraParameters) - Method in class com.azure.ai.inference.EmbeddingsClient: Return the embedding vectors for given text prompts.
Enable client logging - Search tag in Overview: Section
endpoint(String) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
endpoint(String) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
endpoint(String) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
ERROR - Static variable in class com.azure.ai.inference.models.ExtraParameters: The service will error if it detected extra parameters in the request payload.
Examples - Search tag in Overview: Section
Examples - Search tag in Overview: Section
ExtraParameters - Class in com.azure.ai.inference.models: Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.
ExtraParameters() - Constructor for class com.azure.ai.inference.models.ExtraParameters: Deprecated.
Use the ExtraParameters.fromString(String) factory method.

F

FLOAT - Static variable in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Floating point.
fromContentItems(List<ChatMessageContentItem>) - Static method in class com.azure.ai.inference.models.ChatRequestUserMessage: Creates an instance of ChatRequestUserMessage class.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatChoice: Reads an instance of ChatChoice from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletions: Reads an instance of ChatCompletions from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolCall: Reads an instance of ChatCompletionsFunctionToolCall from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolDefinition: Reads an instance of ChatCompletionsFunctionToolDefinition from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoice: Reads an instance of ChatCompletionsNamedToolChoice from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoiceFunction: Reads an instance of ChatCompletionsNamedToolChoiceFunction from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsOptions: Reads an instance of ChatCompletionsOptions from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsResponseFormat: Reads an instance of ChatCompletionsResponseFormat from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonObject: Reads an instance of ChatCompletionsResponseFormatJsonObject from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchema: Reads an instance of ChatCompletionsResponseFormatJsonSchema from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Reads an instance of ChatCompletionsResponseFormatJsonSchemaDefinition from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatText: Reads an instance of ChatCompletionsResponseFormatText from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsToolCall: Reads an instance of ChatCompletionsToolCall from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatCompletionsToolDefinition: Reads an instance of ChatCompletionsToolDefinition from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatMessageContentItem: Reads an instance of ChatMessageContentItem from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatMessageImageContentItem: Reads an instance of ChatMessageImageContentItem from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatMessageImageUrl: Reads an instance of ChatMessageImageUrl from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatMessageTextContentItem: Reads an instance of ChatMessageTextContentItem from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatRequestAssistantMessage: Reads an instance of ChatRequestAssistantMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatRequestDeveloperMessage: Reads an instance of ChatRequestDeveloperMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatRequestMessage: Reads an instance of ChatRequestMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatRequestSystemMessage: Reads an instance of ChatRequestSystemMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatRequestToolMessage: Reads an instance of ChatRequestToolMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatRequestUserMessage: Reads an instance of ChatRequestUserMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ChatResponseMessage: Reads an instance of ChatResponseMessage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.CompletionsUsage: Reads an instance of CompletionsUsage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.EmbeddingInput: Reads an instance of EmbeddingInput from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.EmbeddingItem: Reads an instance of EmbeddingItem from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.EmbeddingsResult: Reads an instance of EmbeddingsResult from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.EmbeddingsUsage: Reads an instance of EmbeddingsUsage from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.FunctionCall: Reads an instance of FunctionCall from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.FunctionDefinition: Reads an instance of FunctionDefinition from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ImageEmbeddingInput: Reads an instance of ImageEmbeddingInput from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.ModelInfo: Reads an instance of ModelInfo from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.StreamingChatChoiceUpdate: Reads an instance of StreamingChatChoiceUpdate from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Reads an instance of StreamingChatCompletionsUpdate from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.StreamingChatResponseMessageUpdate: Reads an instance of StreamingChatResponseMessageUpdate from the JsonReader.
fromJson(JsonReader) - Static method in class com.azure.ai.inference.models.StreamingChatResponseToolCallUpdate: Reads an instance of StreamingChatResponseToolCallUpdate from the JsonReader.
fromString(String) - Static method in class com.azure.ai.inference.models.ChatCompletionsToolChoicePreset: Creates or finds a ChatCompletionsToolChoicePreset from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.ChatMessageImageDetailLevel: Creates or finds a ChatMessageImageDetailLevel from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.ChatRequestUserMessage: Creates an instance of ChatRequestUserMessage class.
fromString(String) - Static method in class com.azure.ai.inference.models.ChatRole: Creates or finds a ChatRole from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.CompletionsFinishReason: Creates or finds a CompletionsFinishReason from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Creates or finds a EmbeddingEncodingFormat from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.EmbeddingInputType: Creates or finds a EmbeddingInputType from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.ExtraParameters: Creates or finds a ExtraParameters from its string representation.
fromString(String) - Static method in class com.azure.ai.inference.models.ModelType: Creates or finds a ModelType from its string representation.
FunctionCall - Class in com.azure.ai.inference.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.inference.models.FunctionCall: Creates an instance of FunctionCall class.
Function calls - Search tag in Overview: Section
FunctionDefinition - Class in com.azure.ai.inference.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.inference.models.FunctionDefinition: Creates an instance of FunctionDefinition class.

G

getAdditionalProperties() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the additionalProperties property: The ChatCompletionsOptions model.
getArguments() - Method in class com.azure.ai.inference.models.FunctionCall: Get the arguments property: The arguments to call the function with, as generated by the model in JSON format.
getChoice() - Method in class com.azure.ai.inference.models.ChatCompletions: Get the choice property: The chat choice associated with this completion response.
getChoice() - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Get the choice property: The chat choice associated with this completion response.
getChoices() - Method in class com.azure.ai.inference.models.ChatCompletions: Get the choices property: The collection of completions choices associated with this completions response.
getChoices() - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Get the choices property: An update to the collection of completion choices associated with this completions response.
getCompletionTokens() - Method in class com.azure.ai.inference.models.CompletionsUsage: Get the completionTokens property: The number of tokens generated across all completions emissions.
getContent() - Method in class com.azure.ai.inference.models.ChatRequestAssistantMessage: Get the content property: The content of the message.
getContent() - Method in class com.azure.ai.inference.models.ChatRequestDeveloperMessage: Get the content property: The contents of the developer message.
getContent() - Method in class com.azure.ai.inference.models.ChatRequestSystemMessage: Get the content property: The contents of the system message.
getContent() - Method in class com.azure.ai.inference.models.ChatRequestToolMessage: Get the content property: The content of the message.
getContent() - Method in class com.azure.ai.inference.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.inference.models.ChatResponseMessage: Get the content property: The content of the message.
getContent() - Method in class com.azure.ai.inference.models.StreamingChatResponseMessageUpdate: Get the content property: The content of the message.
getCreated() - Method in class com.azure.ai.inference.models.ChatCompletions: Get the created property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
getCreated() - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Get the created property: The first timestamp associated with generation activity for this completions response, represented as seconds since the beginning of the Unix epoch of 00:00 on 1 Jan 1970.
getData() - Method in class com.azure.ai.inference.models.EmbeddingsResult: Get the data property: Embedding values for the prompts submitted in the request.
getDelta() - Method in class com.azure.ai.inference.models.StreamingChatChoiceUpdate: Get the delta property: An update to the chat message for a given chat completions prompt.
getDescription() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Get the description property: A description of the response format, used by the AI model to determine how to generate responses in this format.
getDescription() - Method in class com.azure.ai.inference.models.FunctionDefinition: Get the description property: A description of what the function does.
getDetail() - Method in class com.azure.ai.inference.models.ChatMessageImageUrl: Get the detail property: The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and accuracy.
getEmbedding() - Method in class com.azure.ai.inference.models.EmbeddingItem: Get the embedding property: List of embedding values for the input prompt.
getEmbeddingList() - Method in class com.azure.ai.inference.models.EmbeddingItem: Get the embedding property: List of embedding values for the input prompt.
getExtraParams() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the extraParams property: Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.
getFinishReason() - Method in class com.azure.ai.inference.models.ChatChoice: Get the finishReason property: The reason that this chat completions choice completed its generated.
getFinishReason() - Method in class com.azure.ai.inference.models.StreamingChatChoiceUpdate: Get the finishReason property: The reason that this chat completions choice completed its generated.
getFrequencyPenalty() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: 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.inference.models.ChatCompletionsFunctionToolCall: Get the function property: The details of the function invocation requested by the tool call.
getFunction() - Method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolDefinition: Get the function property: The function definition details for the function tool.
getFunction() - Method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoice: Get the function property: The function that should be called.
getFunction() - Method in class com.azure.ai.inference.models.ChatCompletionsToolCall: Get the function property: The details of the function call requested by the AI model.
getFunction() - Method in class com.azure.ai.inference.models.ChatCompletionsToolDefinition: Get the function property: The function definition details for the function tool.
getFunction() - Method in class com.azure.ai.inference.models.StreamingChatResponseToolCallUpdate: Get the function property: Updates to the function call requested by the AI model.
getId() - Method in class com.azure.ai.inference.models.ChatCompletions: Get the id property: A unique identifier associated with this chat completions response.
getId() - Method in class com.azure.ai.inference.models.ChatCompletionsToolCall: Get the id property: The ID of the tool call.
getId() - Method in class com.azure.ai.inference.models.EmbeddingsResult: Get the id property: Unique identifier for the embeddings result.
getId() - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Get the id property: A unique identifier associated with this chat completions response.
getId() - Method in class com.azure.ai.inference.models.StreamingChatResponseToolCallUpdate: Get the id property: The ID of the tool call.
getImage() - Method in class com.azure.ai.inference.models.EmbeddingInput: Get the image property: The input image, in PNG format.
getImage() - Method in class com.azure.ai.inference.models.ImageEmbeddingInput: Get the image property: The input image encoded in base64 string as a data URL.
getImageUrl() - Method in class com.azure.ai.inference.models.ChatMessageImageContentItem: Get the imageUrl property: An internet location, which must be accessible to the model,from which the image may be retrieved.
getIndex() - Method in class com.azure.ai.inference.models.ChatChoice: Get the index property: The ordered index associated with this chat completions choice.
getIndex() - Method in class com.azure.ai.inference.models.EmbeddingItem: Get the index property: Index of the prompt to which the EmbeddingItem corresponds.
getIndex() - Method in class com.azure.ai.inference.models.StreamingChatChoiceUpdate: Get the index property: The ordered index associated with this chat completions choice.
getJsonSchema() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchema: Get the jsonSchema property: The definition of the required JSON schema in the response, and associated metadata.
getLatest() - Static method in enum com.azure.ai.inference.ModelServiceVersion: Gets the latest service version supported by this client library.
getMaxTokens() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the maxTokens property: The maximum number of tokens to generate.
getMessage() - Method in class com.azure.ai.inference.models.ChatChoice: Get the message property: The chat message for a given chat completions prompt.
getMessages() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the messages property: The collection of context messages associated with this chat completions request.
getModel() - Method in class com.azure.ai.inference.models.ChatCompletions: Get the model property: The model used for the chat completion.
getModel() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the model property: ID of the specific AI model to use, if more than one model is available on the endpoint.
getModel() - Method in class com.azure.ai.inference.models.EmbeddingsResult: Get the model property: The model ID used to generate this result.
getModel() - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Get the model property: The model used for the chat completion.
getModelInfo() - Method in class com.azure.ai.inference.ChatCompletionsAsyncClient: Returns information about the AI model.
getModelInfo() - Method in class com.azure.ai.inference.ChatCompletionsClient: Returns information about the AI model.
getModelInfo() - Method in class com.azure.ai.inference.EmbeddingsAsyncClient: Returns information about the AI model.
getModelInfo() - Method in class com.azure.ai.inference.EmbeddingsClient: Returns information about the AI model.
Get Model information - Search tag in Overview: Section
getModelName() - Method in class com.azure.ai.inference.models.ModelInfo: Get the modelName property: The name of the AI model.
getModelProviderName() - Method in class com.azure.ai.inference.models.ModelInfo: Get the modelProviderName property: The model provider name.
getModelType() - Method in class com.azure.ai.inference.models.ModelInfo: Get the modelType property: The type of the AI model.
getName() - Method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoiceFunction: Get the name property: The name of the function that should be called.
getName() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Get the name property: A name that labels this JSON schema.
getName() - Method in class com.azure.ai.inference.models.FunctionCall: Get the name property: The name of the function to call.
getName() - Method in class com.azure.ai.inference.models.FunctionDefinition: Get the name property: The name of the function to be called.
getParameters() - Method in class com.azure.ai.inference.models.FunctionDefinition: Get the parameters property: The parameters the function accepts, described as a JSON Schema object.
getPresencePenalty() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
getPromptTokens() - Method in class com.azure.ai.inference.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.inference.models.EmbeddingsUsage: Get the promptTokens property: Number of tokens in the request.
getResponseFormat() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the responseFormat property: An object specifying the format that the model must output.
getRole() - Method in class com.azure.ai.inference.models.ChatRequestAssistantMessage: Get the role property: The chat role associated with this message.
getRole() - Method in class com.azure.ai.inference.models.ChatRequestDeveloperMessage: Get the role property: The chat role associated with this message.
getRole() - Method in class com.azure.ai.inference.models.ChatRequestMessage: Get the role property: The chat role associated with this message.
getRole() - Method in class com.azure.ai.inference.models.ChatRequestSystemMessage: Get the role property: The chat role associated with this message.
getRole() - Method in class com.azure.ai.inference.models.ChatRequestToolMessage: Get the role property: The chat role associated with this message.
getRole() - Method in class com.azure.ai.inference.models.ChatRequestUserMessage: Get the role property: The chat role associated with this message.
getRole() - Method in class com.azure.ai.inference.models.ChatResponseMessage: Get the role property: The chat role associated with the message.
getRole() - Method in class com.azure.ai.inference.models.StreamingChatResponseMessageUpdate: Get the role property: The chat role associated with the message.
getSchema() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Get the schema property: The definition of the JSON schema.
getSeed() - Method in class com.azure.ai.inference.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.
getStop() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the stop property: A collection of textual sequences that will end completions generation.
getTemperature() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
getText() - Method in class com.azure.ai.inference.models.ChatMessageTextContentItem: Get the text property: The content of the message.
getText() - Method in class com.azure.ai.inference.models.EmbeddingInput: Get the text property: Optional.
getText() - Method in class com.azure.ai.inference.models.ImageEmbeddingInput: Get the text property: Optional.
Getting started - Search tag in Overview: Section
getToolCallId() - Method in class com.azure.ai.inference.models.ChatRequestToolMessage: Get the toolCallId property: The ID of the tool call resolved by the provided content.
getToolCalls() - Method in class com.azure.ai.inference.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.inference.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.
getToolCalls() - Method in class com.azure.ai.inference.models.StreamingChatResponseMessageUpdate: 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.inference.models.ChatCompletionsOptions: Get the toolChoice property: If specified, the model will configure which of the provided tools it can use for the chat completions response.
getTools() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the tools property: A list of tools the model may request to call.
getTopP() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the topP property: An alternative to sampling with temperature called nucleus sampling.
getTotalTokens() - Method in class com.azure.ai.inference.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.inference.models.EmbeddingsUsage: Get the totalTokens property: Total number of tokens transacted in this request/response.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolCall: Get the type property: The object type.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolDefinition: Get the type property: The object type.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoice: Get the type property: The type of the tool.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormat: Get the type property: The response format type to use for chat completions.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonObject: Get the type property: The response format type to use for chat completions.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchema: Get the type property: The response format type to use for chat completions.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatText: Get the type property: The response format type to use for chat completions.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsToolCall: Get the type property: The type of tool call.
getType() - Method in class com.azure.ai.inference.models.ChatCompletionsToolDefinition: Get the type property: The type of the tool.
getType() - Method in class com.azure.ai.inference.models.ChatMessageContentItem: Get the type property: The discriminated object type.
getType() - Method in class com.azure.ai.inference.models.ChatMessageImageContentItem: Get the type property: The discriminated object type.
getType() - Method in class com.azure.ai.inference.models.ChatMessageTextContentItem: Get the type property: The discriminated object type.
getUrl() - Method in class com.azure.ai.inference.models.ChatMessageImageUrl: Get the url property: The URL of the image.
getUsage() - Method in class com.azure.ai.inference.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.inference.models.EmbeddingsResult: Get the usage property: Usage counts for tokens input using the embeddings API.
getUsage() - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate: Get the usage property: Usage information for tokens processed and generated as part of this completions operation.
getVersion() - Method in enum com.azure.ai.inference.ModelServiceVersion

H

HIGH - Static variable in class com.azure.ai.inference.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.
httpClient(HttpClient) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
httpClient(HttpClient) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
httpClient(HttpClient) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
httpLogOptions(HttpLogOptions) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .

I

IMAGE_EMBEDDINGS - Static variable in class com.azure.ai.inference.models.ModelType: A model capable of generating embeddings from an image.
IMAGE_GENERATION - Static variable in class com.azure.ai.inference.models.ModelType: A model capable of generating images from an image and text description.
ImageEmbeddingInput - Class in com.azure.ai.inference.models: Represents an image with optional text.
ImageEmbeddingInput(String) - Constructor for class com.azure.ai.inference.models.ImageEmbeddingInput: Creates an instance of ImageEmbeddingInput class.
ImageEmbeddingInput(Path, String) - Constructor for class com.azure.ai.inference.models.ImageEmbeddingInput: Creates an instance of ImageEmbeddingInput class.
ImageEmbeddingsAsyncClient - Class in com.azure.ai.inference: Initializes a new instance of the asynchronous ImageEmbeddingsClient type.
ImageEmbeddingsClient - Class in com.azure.ai.inference: Initializes a new instance of the synchronous ImageEmbeddingsClient type.
ImageEmbeddingsClientBuilder - Class in com.azure.ai.inference: A builder for creating a new instance of the ImageEmbeddingsClient type.
ImageEmbeddingsClientBuilder() - Constructor for class com.azure.ai.inference.ImageEmbeddingsClientBuilder: Create an instance of the ImageEmbeddingsClientBuilder.
INT8 - Static variable in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Signed 8-bit integer.
isStream() - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Get the stream property: A value indicating whether chat completions should be streamed for this request.
isStrict() - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Get the strict property: If set to true, the service will error out if the provided JSON schema contains keywords not supported by the AI model.

K

Key concepts - Search tag in Overview: Section

L

LOW - Static variable in class com.azure.ai.inference.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.

M

ModelInfo - Class in com.azure.ai.inference.models: Represents some basic information about the AI model.
ModelServiceVersion - Enum in com.azure.ai.inference: Service version of ModelClient.
ModelType - Class in com.azure.ai.inference.models: The type of AI model.
ModelType() - Constructor for class com.azure.ai.inference.models.ModelType: Deprecated.
Use the ModelType.fromString(String) factory method.

N

Next steps - Search tag in Overview: Section
NONE - Static variable in class com.azure.ai.inference.models.ChatCompletionsToolChoicePreset: Specifies that the model should not respond with a tool call and should instead provide a standard chat completions response.

P

PASS_THROUGH - Static variable in class com.azure.ai.inference.models.ExtraParameters: The service will pass extra parameters to the back-end AI model.
pipeline(HttpPipeline) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
pipeline(HttpPipeline) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
pipeline(HttpPipeline) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
Prerequisites - Search tag in Overview: Section

Q

QUERY - Static variable in class com.azure.ai.inference.models.EmbeddingInputType: Indicates the input represents a search query to find the most relevant documents in your vector database.

R

REQUIRED - Static variable in class com.azure.ai.inference.models.ChatCompletionsToolChoicePreset: Specifies that the model should respond with a call to one or more tools.
retryOptions(RetryOptions) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: .
retryOptions(RetryOptions) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: .
retryOptions(RetryOptions) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: .
retryPolicy(RetryPolicy) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: Sets The retry policy that will attempt to retry failed requests, if applicable.
retryPolicy(RetryPolicy) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: Sets The retry policy that will attempt to retry failed requests, if applicable.
retryPolicy(RetryPolicy) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: Sets The retry policy that will attempt to retry failed requests, if applicable.

S

scopes(String[]) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: Sets auth domain scopes for client authentication.
scopes(String[]) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: Sets auth domain scopes for client authentication.
scopes(String[]) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: Sets auth domain scopes for client authentication.
Select a service API version - Search tag in Overview: Section
Service API versions - Search tag in Overview: Section
serviceVersion(ModelServiceVersion) - Method in class com.azure.ai.inference.ChatCompletionsClientBuilder: Sets Service version.
serviceVersion(ModelServiceVersion) - Method in class com.azure.ai.inference.EmbeddingsClientBuilder: Sets Service version.
serviceVersion(ModelServiceVersion) - Method in class com.azure.ai.inference.ImageEmbeddingsClientBuilder: Sets Service version.
setAdditionalProperties(Map<String, BinaryData>) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the additionalProperties property: The ChatCompletionsOptions model.
setContent(String) - Method in class com.azure.ai.inference.models.ChatRequestAssistantMessage: Set the content property: The content of the message.
setContent(String) - Method in class com.azure.ai.inference.models.ChatRequestToolMessage: Set the content property: The content of the message.
setDescription(String) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Set the description property: A description of the response format, used by the AI model to determine how to generate responses in this format.
setDescription(String) - Method in class com.azure.ai.inference.models.FunctionDefinition: Set the description property: A description of what the function does.
setDetail(ChatMessageImageDetailLevel) - Method in class com.azure.ai.inference.models.ChatMessageImageUrl: Set the detail property: The evaluation quality setting to use, which controls relative prioritization of speed, token consumption, and accuracy.
setExtraParams(ExtraParameters) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the extraParams property: Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload.
setFrequencyPenalty(Double) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the frequencyPenalty property: A value that influences the probability of generated tokens appearing based on their cumulative frequency in generated text.
setJsonFormat(String, Map<String, BinaryData>) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the responseFormat to a given JSON schema: The format that the model must output.
setMaxTokens(Integer) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the maxTokens property: The maximum number of tokens to generate.
setModel(String) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the model property: ID of the specific AI model to use, if more than one model is available on the endpoint.
setParameters(BinaryData) - Method in class com.azure.ai.inference.models.FunctionDefinition: Set the parameters property: The parameters the function accepts, described as a JSON Schema object.
setPresencePenalty(Double) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the presencePenalty property: A value that influences the probability of generated tokens appearing based on their existing presence in generated text.
setResponseFormat(ChatCompletionsResponseFormat) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the responseFormat property: An object specifying the format that the model must output.
setSeed(Long) - Method in class com.azure.ai.inference.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.
setStop(List<String>) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the stop property: A collection of textual sequences that will end completions generation.
setStrict(Boolean) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition: Set the strict property: If set to true, the service will error out if the provided JSON schema contains keywords not supported by the AI model.
setTemperature(Double) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the temperature property: The sampling temperature to use that controls the apparent creativity of generated completions.
setText(String) - Method in class com.azure.ai.inference.models.EmbeddingInput: Set the text property: Optional.
setText(String) - Method in class com.azure.ai.inference.models.ImageEmbeddingInput: Set the text property: Optional.
setToolCalls(List<ChatCompletionsToolCall>) - Method in class com.azure.ai.inference.models.ChatRequestAssistantMessage: Set the toolCalls property: The tool calls that must be resolved and have their outputs appended to subsequent input messages for the chat completions request to resolve as configured.
setToolChoice(BinaryData) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the toolChoice property: If specified, the model will configure which of the provided tools it can use for the chat completions response.
setTools(List<ChatCompletionsToolDefinition>) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the tools property: A list of tools the model may request to call.
setTopP(Double) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions: Set the topP property: An alternative to sampling with temperature called nucleus sampling.
STOPPED - Static variable in class com.azure.ai.inference.models.CompletionsFinishReason: Completions ended normally and reached its end of token generation.
StreamingChatChoiceUpdate - Class in com.azure.ai.inference.models: Represents an update to a single prompt completion when the service is streaming updates using Server Sent Events (SSE).
Streaming chat completions - Search tag in Overview: Section
StreamingChatCompletionsUpdate - Class in com.azure.ai.inference.models: Represents a response update to a chat completions request, when the service is streaming updates using Server Sent Events (SSE).
StreamingChatResponseMessageUpdate - Class in com.azure.ai.inference.models: A representation of a chat message update as received in a streaming response.
StreamingChatResponseToolCallUpdate - Class in com.azure.ai.inference.models: An update to the function tool call information requested by the AI model.
Streaming function calls - Search tag in Overview: Section
SYSTEM - Static variable in class com.azure.ai.inference.models.ChatRole: The role that instructs or sets the behavior of the assistant.

T

TEXT - Static variable in class com.azure.ai.inference.models.EmbeddingInputType: Indicates the input is a general text input.
TEXT_GENERATION - Static variable in class com.azure.ai.inference.models.ModelType: A text generation model.
Text embeddings - Search tag in Overview: Section
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatChoice
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletions
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolCall
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsFunctionToolDefinition
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoice
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsNamedToolChoiceFunction
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsOptions
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormat
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonObject
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchema
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatJsonSchemaDefinition
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsResponseFormatText
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsToolCall
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatCompletionsToolDefinition
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatMessageContentItem
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatMessageImageContentItem
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatMessageImageUrl
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatMessageTextContentItem
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatRequestAssistantMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatRequestDeveloperMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatRequestMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatRequestSystemMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatRequestToolMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatRequestUserMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ChatResponseMessage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.CompletionsUsage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.EmbeddingInput
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.EmbeddingItem
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.EmbeddingsResult
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.EmbeddingsUsage
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.FunctionCall
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.FunctionDefinition
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ImageEmbeddingInput
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.ModelInfo
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.StreamingChatChoiceUpdate
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.StreamingChatCompletionsUpdate
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.StreamingChatResponseMessageUpdate
toJson(JsonWriter) - Method in class com.azure.ai.inference.models.StreamingChatResponseToolCallUpdate
TOKEN_LIMIT_REACHED - Static variable in class com.azure.ai.inference.models.CompletionsFinishReason: Completions exhausted available token limits before generation could complete.
TOOL - Static variable in class com.azure.ai.inference.models.ChatRole: The role that represents extension tool activity within a chat completions operation.
TOOL_CALLS - Static variable in class com.azure.ai.inference.models.CompletionsFinishReason: Completion ended with the model calling a provided tool for output.
Troubleshooting - Search tag in Overview: Section

U

UBINARY - Static variable in class com.azure.ai.inference.models.EmbeddingEncodingFormat: ubinary.
UINT8 - Static variable in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Unsigned 8-bit integer.
USER - Static variable in class com.azure.ai.inference.models.ChatRole: The role that provides input for chat completions.

V

V2024_05_01_PREVIEW - Enum constant in enum com.azure.ai.inference.ModelServiceVersion: Enum value 2024-05-01-preview.
V2024_08_01_PREVIEW - Enum constant in enum com.azure.ai.inference.ModelServiceVersion: Enum value 2024-08-01-preview.
valueOf(String) - Static method in enum com.azure.ai.inference.ModelServiceVersion: Returns the enum constant of this type with the specified name.
values() - Static method in class com.azure.ai.inference.models.ChatCompletionsToolChoicePreset: Gets known ChatCompletionsToolChoicePreset values.
values() - Static method in class com.azure.ai.inference.models.ChatMessageImageDetailLevel: Gets known ChatMessageImageDetailLevel values.
values() - Static method in class com.azure.ai.inference.models.ChatRole: Gets known ChatRole values.
values() - Static method in class com.azure.ai.inference.models.CompletionsFinishReason: Gets known CompletionsFinishReason values.
values() - Static method in class com.azure.ai.inference.models.EmbeddingEncodingFormat: Gets known EmbeddingEncodingFormat values.
values() - Static method in class com.azure.ai.inference.models.EmbeddingInputType: Gets known EmbeddingInputType values.
values() - Static method in class com.azure.ai.inference.models.ExtraParameters: Gets known ExtraParameters values.
values() - Static method in class com.azure.ai.inference.models.ModelType: Gets known ModelType values.
values() - Static method in enum com.azure.ai.inference.ModelServiceVersion: Returns an array containing the constants of this enum type, in the order they are declared.

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