1DP Azure AI Projects Typespec

specification/ai/Azure.AI.Projects/assistants/common/models.tsp

@@ -0,0 +1,176 @@
+import "@typespec/http";
+import "@typespec/versioning";
+
+using TypeSpec.Http;
+using TypeSpec.Versioning;
+
+namespace Azure.AI.Projects.Assistants;
+
+@doc("The possible values for roles attributed to messages in a thread.")
+union MessageRole {
+  string,
+
+  @doc("The role representing the end-user.")
+  user: "user",
+
+  @doc("The role representing the agent.")
+  agent: "assistant",
+}
+
+@doc("The available sorting options when requesting a list of response objects.")
+union ListSortOrder {
+  string,
+
+  @doc("Specifies an ascending sort order.")
+  ascending: "asc",
+
+  @doc("Specifies a descending sort order.")
+  descending: "desc",
+}
+
+alias OpenAIListRequestOptions = {
+  @doc("A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.")
+  @query
+  limit?: int32 = 20;
+
+  @doc("Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.")
+  @query
+  order?: ListSortOrder = ListSortOrder.descending;
+
+  @doc("A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.")
+  @query
+  after?: string;
+
+  @doc("A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.")
+  @query
+  before?: string;
+};
+
+#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name"
+@doc("The response data for a requested list of items.")
+model OpenAIPageableListOf<T> {
+  @doc("The object type, which is always list.")
+  object: "list";
+
+  @doc("The requested list of items.")
+  data: T[];
+
+  @encodedName("application/json", "first_id")
+  @doc("The first ID represented in this list.")
+  firstId: string;
+
+  @encodedName("application/json", "last_id")
+  @doc("The last ID represented in this list.")
+  lastId: string;
+
+  @encodedName("application/json", "has_more")
+  @doc("A value indicating whether there are additional values available not captured in this list.")
+  hasMore: boolean;
+}
+
+alias DeletionStatus = {
+  @doc("The ID of the resource specified for deletion.")
+  id: string;
+
+  @doc("A value indicating whether deletion was successful.")
+  deleted: boolean;
+};
+
+alias RequiredNullableMetadata = {
+  /**
+   * A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality"
+  metadata: Record<string> | null;
+};
+
+alias OptionalNullableMetadata = {
+  /**
+   * A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.
+   */
+  #suppress "@azure-tools/typespec-azure-core/no-nullable" "OpenAI uses explicit nullability, distinct from optionality"
+  metadata?: Record<string> | null;
+};
+
+/**
+ * Specifies the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models since `gpt-3.5-turbo-1106`.
+ *
+ * Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is valid JSON.
+ *
+ * **Important:** when using JSON mode, you **must** also instruct the model to produce JSON yourself via a system or user message.
+ * Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit,
+ * resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off
+ * if `finish_reason="length"`, which indicates the generation exceeded `max_tokens` or the conversation exceeded the max context length.
+ */
+#suppress "@azure-tools/typespec-autorest/union-unsupported" "This union is defined according to the OpenAI API"
+union AgentsApiResponseFormatOption {
+  string,
+
+  /** The model will handle the return format. */
+  AgentsApiResponseFormatMode,
+
+  /** Sets the format of the output of the model when a ToolCall is returned. */
+  AgentsApiResponseFormat,
+
+  /** Using `json_schema` format will provide a description of what the response format is for. */
+  ResponseFormatJsonSchemaType,
+}
+
+/** Represents the mode in which the model will handle the return format of a tool call. */
+union AgentsApiResponseFormatMode {
+  string,
+
+  /** Default value. Let the model handle the return format. */
+  "auto",
+
+  /** Setting the value to `none`, will result in a 400 Bad request. */
+  "none",
+}
+
+/**
+ * An object describing the expected output of the model. If `json_object` only `function` type `tools` are allowed to be passed to the Run.
+ * If `text` the model can return text or any value needed.
+ */
+model AgentsApiResponseFormat {
+  /** Must be one of `text` or `json_object`. */
+  type?: ResponseFormat = ResponseFormat.text;
+}
+
+/** Possible API response formats. */
+#suppress "@azure-tools/typespec-autorest/union-unsupported" "OpenAPI v2 support deferred"
+union ResponseFormat {
+  string,
+
+  /** `text` format should be used for requests involving any sort of ToolCall. */
+  text: "text",
+
+  /** Using `json_object` format will limit the usage of ToolCall to only functions. */
+  jsonObject: "json_object",
+}
+
+/**
+ * The type of response format being defined: `json_schema`
+ */
+model ResponseFormatJsonSchemaType {
+  /** Type */
+  type: "json_schema";
+
+  /** The JSON schema, describing response format. */
+  @encodedName("application/json", "json_schema")
+  jsonSchema: ResponseFormatJsonSchema;
+}
+
+/**
+ * A description of what the response format is for, used by the model to determine how to respond in the format.
+ */
+#suppress "@azure-tools/typespec-azure-core/no-unknown" "JSON schema takes an arbitrary json"
+model ResponseFormatJsonSchema {
+  /** A description of what the response format is for, used by the model to determine how to respond in the format. */
+  description?: string;
+
+  /** The name of a schema. */
+  name: string;
+
+  /** The JSON schema object, describing the response format. */
+  schema: unknown;
+}

specification/ai/Azure.AI.Projects/assistants/files/models.tsp

@@ -0,0 +1,121 @@
+import "@typespec/versioning";
+
+namespace Azure.AI.Projects.Assistants;
+
+using TypeSpec.Versioning;
+
+#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name"
+@doc("Represents an agent that can call the model and use tools.")
+model OpenAIFile {
+  @doc("The object type, which is always 'file'.")
+  object: "file";
+
+  @doc("The identifier, which can be referenced in API endpoints.")
+  id: string;
+
+  @doc("The size of the file, in bytes.")
+  bytes: int32;
+
+  @doc("The name of the file.")
+  filename: string;
+
+  @encodedName("application/json", "created_at")
+  @encode(DateTimeKnownEncoding.unixTimestamp, int32)
+  @doc("The Unix timestamp, in seconds, representing when this object was created.")
+  createdAt: utcDateTime;
+
+  @doc("The intended purpose of a file.")
+  purpose: FilePurpose;
+
+  /** The state of the file. This field is available in Azure OpenAI only. */
+  status?: FileState;
+
+  /** The error message with details in case processing of this file failed. This field is available in Azure OpenAI only. */
+  @encodedName("application/json", "status_details")
+  statusDetails?: string;
+}
+
+/** The state of the file. */
+union FileState {
+  string,
+
+  /**
+   * The file has been uploaded but it's not yet processed. This state is not returned by Azure OpenAI and exposed only for
+   * compatibility. It can be categorized as an inactive state.
+   */
+  uploaded: "uploaded",
+
+  /**
+   * The operation was created and is not queued to be processed in the future. It can be categorized as an inactive state.
+   */
+  pending: "pending",
+
+  /** The operation has started to be processed. It can be categorized as an active state. */
+  running: "running",
+
+  /**
+   * The operation has successfully processed and is ready for consumption. It can be categorized as a terminal state.
+   */
+  processed: "processed",
+
+  /**
+   * The operation has completed processing with a failure and cannot be further consumed. It can be categorized as a terminal state.
+   */
+  error: "error",
+
+  /**
+   * The entity is in the process to be deleted. This state is not returned by Azure OpenAI and exposed only for compatibility.
+   * It can be categorized as an active state.
+   */
+  deleting: "deleting",
+
+  /**
+   * The entity has been deleted but may still be referenced by other entities predating the deletion. It can be categorized as a
+   * terminal state.
+   */
+  deleted: "deleted",
+}
+
+/** The possible values denoting the intended usage of a file. */
+union FilePurpose {
+  string,
+
+  /** Indicates a file is used for fine tuning input. */
+  fineTune: "fine-tune",
+
+  /** Indicates a file is used for fine tuning results. */
+  fineTuneResults: "fine-tune-results",
+
+  /** Indicates a file is used as input to agents. */
+  agents: "assistants",
+
+  /** Indicates a file is used as output by agents. */
+  agentsOutput: "assistants_output",
+
+  /** Indicates a file is used as input to . */
+  batch: "batch",
+
+  /** Indicates a file is used as output by a vector store batch operation. */
+  batchOutput: "batch_output",
+
+  /** Indicates a file is used as input to a vision operation. */
+  vision: "vision",
+}
+
+@doc("The response data from a file list operation.")
+model FileListResponse {
+  @doc("The object type, which is always 'list'.")
+  object: "list";
+
+  @doc("The files returned for the request.")
+  data: OpenAIFile[];
+}
+
+#suppress "@azure-tools/typespec-azure-core/composition-over-inheritance" "https://github.com/Azure/autorest.csharp/issues/4041"
+@doc("A status response from a file deletion operation.")
+model FileDeletionStatus {
+  ...DeletionStatus;
+
+  @doc("The object type, which is always 'file'.")
+  object: "file";
+}