B C E G J O T W
All Classes All Packages
All Classes All Packages
All Classes All Packages
B
- BinaryDataUtils - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion
- BinaryDataUtils() - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.BinaryDataUtils
- build() - Method in class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiAudioToTextService.Builder
-
builds the OpenAiAudioToTextService.
- build() - Method in class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiTextToAudioService.Builder
-
Builds the OpenAi text to audio service.
- build() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion.Builder
- build() - Method in class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAITextGenerationService.Builder
- build() - Method in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService.Builder
- builder() - Static method in class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiAudioToTextService
-
Builder for OpenAiAudioToTextService.
- builder() - Static method in class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiTextToAudioService
-
Creates a new builder.
- builder() - Static method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion
-
Create a new instance of
OpenAIChatCompletion.Builder. - builder() - Static method in class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAITextGenerationService
-
Creates a builder for creating a
OpenAITextGenerationService. - builder() - Static method in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService
-
Creates a builder for creating a
OpenAITextEmbeddingGenerationService. - Builder() - Constructor for class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiAudioToTextService.Builder
- Builder() - Constructor for class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiTextToAudioService.Builder
- Builder() - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion.Builder
- Builder() - Constructor for class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAITextGenerationService.Builder
- Builder() - Constructor for class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService.Builder
C
- ChatCompletionsJsonSchemaResponseFormat - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat
-
Represents a response format for chat completions that uses a JSON schema.
- ChatCompletionsJsonSchemaResponseFormat(JsonResponseSchema) - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat.ChatCompletionsJsonSchemaResponseFormat
-
Creates a new instance of the
ChatCompletionsJsonSchemaResponseFormatclass. - com.microsoft.semantickernel.aiservices.openai - package com.microsoft.semantickernel.aiservices.openai
- com.microsoft.semantickernel.aiservices.openai.audio - package com.microsoft.semantickernel.aiservices.openai.audio
- com.microsoft.semantickernel.aiservices.openai.chatcompletion - package com.microsoft.semantickernel.aiservices.openai.chatcompletion
- com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat - package com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat
- com.microsoft.semantickernel.aiservices.openai.textcompletion - package com.microsoft.semantickernel.aiservices.openai.textcompletion
- com.microsoft.semantickernel.aiservices.openai.textembedding - package com.microsoft.semantickernel.aiservices.openai.textembedding
E
- EMBEDDING_DIMENSIONS_LARGE - Static variable in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService
-
Dimension of the OpenAI
text-embedding-3-largemodel. - EMBEDDING_DIMENSIONS_SMALL - Static variable in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService
-
Dimension of the OpenAI
text-embedding-3-smallmodel.
G
- generateEmbeddingAsync(String) - Method in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService
-
Generates embeddings for the given data.
- generateEmbeddingsAsync(List<String>) - Method in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService
-
Generates embeddings for the given data.
- generateSchema(Class<?>) - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat.JacksonResponseFormatGenerator
- getArguments() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIFunctionToolCall
-
Gets a name/value collection of the arguments to the function, if any.
- getAudioContentAsync(String, TextToAudioExecutionSettings) - Method in class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiTextToAudioService
- getChatMessageContentsAsync(ChatHistory, Kernel, InvocationContext) - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion
- getChatMessageContentsAsync(String, Kernel, InvocationContext) - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion
- getChoices() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse
-
Gets the choices of the chat completion response.
- getCompletionTokens() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Usage
-
Gets the number of tokens used for the completion.
- getContent() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Message
-
Gets the content of the message.
- getContent() - Method in class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAIStreamingTextContent
- getCreated() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse
-
Gets the created time of the chat completion response.
- getDeploymentName() - Method in class com.microsoft.semantickernel.aiservices.openai.OpenAiService
-
Gets the deployment name.
- getFinishDetails() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Choice
-
Gets the finish details in the chat completion response.
- getFunctionName() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIFunctionToolCall
-
Gets the name of the function.
- getId() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse
-
Gets the id of the chat completion response.
- getId() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIFunctionToolCall
-
Gets the ID of the tool call.
- getId() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIStreamingChatMessageContent
- getIndex() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Choice
-
Gets the index of the choice.
- getMessage() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Choice
-
Gets the message in the chat completion response.
- getModel() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse
-
Gets the model of the chat completion response.
- getModelId() - Method in class com.microsoft.semantickernel.aiservices.openai.OpenAiService
- getObject() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse
-
Gets the object of the chat completion response.
- getPluginName() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIFunctionToolCall
-
Gets the name of the plugin with which this function is associated, if any.
- getPromptTokens() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Usage
-
Gets the number of tokens used for the prompt.
- getRole() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Message
-
Gets the role of the message.
- getServiceId() - Method in class com.microsoft.semantickernel.aiservices.openai.OpenAiService
- getStreamingChatMessageContentsAsync(ChatHistory, Kernel, InvocationContext) - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion
- getStreamingChatMessageContentsAsync(String, Kernel, InvocationContext) - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatCompletion
- getStreamingTextContentsAsync(String, PromptExecutionSettings, Kernel) - Method in class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAITextGenerationService
- getTextContentsAsync(AudioContent, AudioToTextExecutionSettings) - Method in class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiAudioToTextService
- getTextContentsAsync(String, PromptExecutionSettings, Kernel) - Method in class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAITextGenerationService
- getToolCall() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatMessageContent
-
Gets any tool calls requested.
- getTotalTokens() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.Usage
-
Gets the total number of tokens used.
- getType() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse.FinishDetails
-
Gets the type of the finish details.
- getType() - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat.ChatCompletionsJsonSchemaResponseFormat
- getUsage() - Method in interface com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatResponse
-
Gets the usage of the chat completion response.
J
- JacksonResponseFormatGenerator - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat
-
Represents a response format generator that uses Jackson.
- JacksonResponseFormatGenerator() - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat.JacksonResponseFormatGenerator
-
Creates a new instance of the
JacksonResponseFormatGeneratorclass. - JacksonResponseFormatGenerator(SchemaGenerator) - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat.JacksonResponseFormatGenerator
-
Creates a new instance of the
JacksonResponseFormatGeneratorclass.
O
- OpenAiAudioToTextService - Class in com.microsoft.semantickernel.aiservices.openai.audio
-
Provides OpenAi implementation of audio to text service.
- OpenAiAudioToTextService(OpenAIAsyncClient, String, String) - Constructor for class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiAudioToTextService
-
Creates an instance of OpenAi audio to text service.
- OpenAiAudioToTextService.Builder - Class in com.microsoft.semantickernel.aiservices.openai.audio
-
Represents a builder for OpenAiAudioToTextService.
- OpenAIChatCompletion - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
OpenAI chat completion service.
- OpenAIChatCompletion.Builder - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Builder for creating a new instance of
OpenAIChatCompletion. - OpenAIChatMessageContent<T> - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents the content of a chat message.
- OpenAIChatMessageContent(AuthorRole, String, String, T, Charset, FunctionResultMetadata<?>, List<OpenAIFunctionToolCall>) - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIChatMessageContent
-
Creates a new instance of the
OpenAIChatMessageContentclass. - OpenAIChatResponse - Interface in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents the response from the OpenAI chat completion API.
- OpenAIChatResponse.Choice - Interface in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents a choice in the chat completion response.
- OpenAIChatResponse.FinishDetails - Interface in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents the finish details in the chat completion response.
- OpenAIChatResponse.Message - Interface in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents a message in the chat completion response.
- OpenAIChatResponse.Usage - Interface in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents the usage of the chat completion API.
- OpenAIFunctionToolCall - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents a call to a function in the OpenAI tool.
- OpenAIFunctionToolCall(String, String, String, KernelFunctionArguments) - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIFunctionToolCall
-
Creates a new instance of the
OpenAIFunctionToolCallclass. - OpenAiService<Client> - Class in com.microsoft.semantickernel.aiservices.openai
-
Provides OpenAI service.
- OpenAIStreamingChatMessageContent<T> - Class in com.microsoft.semantickernel.aiservices.openai.chatcompletion
-
Represents the content of a chat message.
- OpenAIStreamingChatMessageContent(String, AuthorRole, String, String, T, Charset, FunctionResultMetadata, List<OpenAIFunctionToolCall>) - Constructor for class com.microsoft.semantickernel.aiservices.openai.chatcompletion.OpenAIStreamingChatMessageContent
-
Creates a new instance of the
OpenAIChatMessageContentclass. - OpenAIStreamingTextContent - Class in com.microsoft.semantickernel.aiservices.openai.textcompletion
-
StreamingTextContent is a wrapper for TextContent that allows for streaming.
- OpenAIStreamingTextContent(TextContent) - Constructor for class com.microsoft.semantickernel.aiservices.openai.textcompletion.OpenAIStreamingTextContent
-
Initializes a new instance of the
StreamingTextContentclass with a provided text content. - OpenAITextEmbeddingGenerationService - Class in com.microsoft.semantickernel.aiservices.openai.textembedding
-
An OpenAI implementation of a
TextEmbeddingGenerationService. - OpenAITextEmbeddingGenerationService(OpenAIAsyncClient, String, String, String, int) - Constructor for class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService
-
Creates a new
OpenAITextEmbeddingGenerationService. - OpenAITextEmbeddingGenerationService.Builder - Class in com.microsoft.semantickernel.aiservices.openai.textembedding
-
A builder for creating a
OpenAITextEmbeddingGenerationService. - OpenAITextGenerationService - Class in com.microsoft.semantickernel.aiservices.openai.textcompletion
-
An OpenAI implementation of a
TextGenerationService. - OpenAITextGenerationService.Builder - Class in com.microsoft.semantickernel.aiservices.openai.textcompletion
-
Builder for a TextGenerationService
- OpenAiTextToAudioService - Class in com.microsoft.semantickernel.aiservices.openai.audio
-
Provides OpenAi implementation of text to audio service.
- OpenAiTextToAudioService(OpenAIAsyncClient, String, String) - Constructor for class com.microsoft.semantickernel.aiservices.openai.audio.OpenAiTextToAudioService
-
Creates an instance of OpenAi text to audio service.
- OpenAiTextToAudioService.Builder - Class in com.microsoft.semantickernel.aiservices.openai.audio
-
Represents a builder for OpenAi text to audio service.
T
- toJson(JsonWriter) - Method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.responseformat.ChatCompletionsJsonSchemaResponseFormat
- toString(BinaryData) - Static method in class com.microsoft.semantickernel.aiservices.openai.chatcompletion.BinaryDataUtils
W
- withDimensions(int) - Method in class com.microsoft.semantickernel.aiservices.openai.textembedding.OpenAITextEmbeddingGenerationService.Builder
-
Sets the dimensions for the embeddings.
All Classes All Packages