OpenAIAssistantDefinition Class

Definition

Namespace:

Microsoft.SemanticKernel.Agents.OpenAI

Assembly:

Microsoft.SemanticKernel.Agents.OpenAI.dll

Package:

Microsoft.SemanticKernel.Agents.OpenAI v1.45.0-preview

Caution

Use the OpenAI.Assistants.AssistantClient.CreateAssistantAsync() to create an assistant definition.

Defines an assistant.

[System.Obsolete("Use the OpenAI.Assistants.AssistantClient.CreateAssistantAsync() to create an assistant definition.")]
public sealed class OpenAIAssistantDefinition : Microsoft.SemanticKernel.Agents.OpenAI.OpenAIAssistantCapabilities

[<System.Obsolete("Use the OpenAI.Assistants.AssistantClient.CreateAssistantAsync() to create an assistant definition.")>]
type OpenAIAssistantDefinition = class
    inherit OpenAIAssistantCapabilities

Public NotInheritable Class OpenAIAssistantDefinition
Inherits OpenAIAssistantCapabilities

Inheritance

Object

OpenAIAssistantCapabilities

OpenAIAssistantDefinition

Attributes

ObsoleteAttribute

Constructors

OpenAIAssistantDefinition(String)

Initializes a new instance of the OpenAIAssistantDefinition class.

Properties

CodeInterpreterFileIds	Gets optional file IDs made available to the code-interpreter tool, if enabled. (Inherited from OpenAIAssistantCapabilities)
Description	Gets the description of the assistant.
EnableCodeInterpreter	Gets a value that indicates whether the code-interpreter tool is enabled. (Inherited from OpenAIAssistantCapabilities)
EnableFileSearch	Gets a value that indicates whether the file_search tool is enabled. (Inherited from OpenAIAssistantCapabilities)
EnableJsonResponse	Gets a value that indicates whether the JSON response format is enabled. (Inherited from OpenAIAssistantCapabilities)
ExecutionOptions	Gets the default execution options for each agent invocation. (Inherited from OpenAIAssistantCapabilities)
Id	Gets the assistant's unique ID. (Ignored on create.) (Inherited from OpenAIAssistantCapabilities)
Instructions	Gets the system instructions for the assistant to use.
Metadata	Gets a set of up to 16 key/value pairs that can be attached to an agent, used for storing additional information about that object in a structured format. (Inherited from OpenAIAssistantCapabilities)
ModelId	Gets the AI model targeted by the agent. (Inherited from OpenAIAssistantCapabilities)
Name	Gets the name of the assistant.
Temperature	Gets the sampling temperature to use, between 0 and 2. (Inherited from OpenAIAssistantCapabilities)
TemplateFactoryFormat	Gets the captured template format for the assistant if needed for agent retrieval (RetrieveAsync(OpenAIClientProvider, String, Kernel, KernelArguments, IPromptTemplateFactory, CancellationToken)).
TopP	Gets the probability mass of tokens whose results are considered in nucleus sampling. (Inherited from OpenAIAssistantCapabilities)
VectorStoreId	Gets the vector store ID. Requires file-search if specified. (Inherited from OpenAIAssistantCapabilities)