OpenAIFilePurpose Struct

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.OpenAI

Assembly:: Microsoft.SemanticKernel.Connectors.OpenAI.dll

Package:: Microsoft.SemanticKernel.Connectors.OpenAI v1.45.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

Use OpenAI SDK or AzureOpenAI SDK clients for file operations. This class is deprecated and will be removed in a future version.

Defines the purpose associated with the uploaded file: https://platform.openai.com/docs/api-reference/files/object#files/object-purpose

[System.Obsolete("Use OpenAI SDK or AzureOpenAI SDK clients for file operations. This class is deprecated and will be removed in a future version.")]
public readonly struct OpenAIFilePurpose : IEquatable<Microsoft.SemanticKernel.Connectors.OpenAI.OpenAIFilePurpose>

[<System.Obsolete("Use OpenAI SDK or AzureOpenAI SDK clients for file operations. This class is deprecated and will be removed in a future version.")>]
type OpenAIFilePurpose = struct

Public Structure OpenAIFilePurpose
Implements IEquatable(Of OpenAIFilePurpose)

Inheritance: ValueType
OpenAIFilePurpose

Attributes: ObsoleteAttribute

Implements: IEquatable<OpenAIFilePurpose>

Constructors

Name	Description
OpenAIFilePurpose(String)	Creates a new OpenAIFilePurpose instance with the provided label.

Properties

Name	Description
Assistants	File to be used by assistants as input.
AssistantsOutput	File produced as assistants output.
Batch	Files uploaded as a batch of API requests
BatchOutput	File produced as result of a file included as a batch request.
FineTune	File to be used as input to fine-tune a model.
FineTuneResults	File produced as result of fine-tuning a model.
Label	Gets the label associated with this OpenAIFilePurpose.
Vision	File to be used for Assistants image file inputs.

Methods

Name	Description
Equals(Object)	Indicates whether this instance and a specified object are equal.
Equals(OpenAIFilePurpose)	Indicates whether the current object is equal to another object of the same type.
GetHashCode()	Returns the hash code for this instance.
ToString()	Returns the fully qualified type name of this instance.

Operators

Name	Description
Equality(OpenAIFilePurpose, OpenAIFilePurpose)	Returns a value indicating whether two OpenAIFilePurpose instances are equivalent, as determined by a case-insensitive comparison of their labels.
Inequality(OpenAIFilePurpose, OpenAIFilePurpose)	Returns a value indicating whether two OpenAIFilePurpose instances are not equivalent, as determined by a case-insensitive comparison of their labels.

Applies to