@azure-rest/ai-inference 1.0.0-alpha.20250331.1 → 1.0.0-alpha.20250401.2

package/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Release History
+
+## 1.0.0-beta.6 (2025-03-18)
+
+### Features Added
+
+- Add "developer" chat role, and ChatRequestDeveloperMessage interface.
+- Added audio input (data and url) to chat completions, with samples.
+
+
+### Bugs Fixed
+
+* Re-export ErrorModel type from azure-rest/core-client (#33333)
+
+## 1.0.0-beta.5 (2025-01-22)
+
+### Breaking Changes
+
+- Change ChatCompletionsResponseFormatJSON class name to ChatCompletionsResponseFormatJsonObject.
+
+### Features Added
+
+- Add samples and tests for image embeddings.
+- Add ChatCompletionsResponseFormatJsonSchema class for structured output in completions response.
+- Add sample for Chat Completions with structured output
+
+## 1.0.0-beta.4 (2024-11-06)
+
+### Other Changes
+
+- Updated README.
+
+## 1.0.0-beta.3 (2024-10-22)
+
+### Features Added
+
+- Adds support for instrumentation using OpenTelemetry for chat completion without streaming.
+
+## 1.0.0-beta.2 (2024-07-17)
+
+### Features Added
+
+- Adds support for text and image embeddings.
+
+## 1.0.0-beta.1 (2024-06-30)
+
+### Features Added
+
+- This is the initial beta release for the Azure AI Inference SDK, which is a common API supporting Azure AI Inference models.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure-rest/ai-inference",
-  "version": "1.0.0-alpha.20250331.1",
+  "version": "1.0.0-alpha.20250401.2",
   "description": "Inference API for Azure-supported AI models",
   "exports": {
     "./package.json": "./package.json",
@@ -45,7 +45,9 @@
   "files": [
     "dist/",
     "README.md",
-    "LICENSE"
+    "LICENSE",
+    "review/",
+    "CHANGELOG.md"
   ],
   "engines": {
     "node": ">=18.0.0"

package/review/ai-inference.api.md

@@ -0,0 +1,525 @@
+## API Report File for "@azure-rest/ai-inference"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import type { Client } from '@azure-rest/core-client';
+import type { ClientOptions } from '@azure-rest/core-client';
+import { ErrorModel } from '@azure-rest/core-client';
+import type { ErrorResponse } from '@azure-rest/core-client';
+import type { HttpResponse } from '@azure-rest/core-client';
+import type { KeyCredential } from '@azure/core-auth';
+import type { RawHttpHeaders } from '@azure/core-rest-pipeline';
+import type { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
+import type { RequestParameters } from '@azure-rest/core-client';
+import type { StreamableMethod } from '@azure-rest/core-client';
+import type { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type AudioContentFormat = string;
+
+// @public
+export interface ChatChoiceOutput {
+    finish_reason: CompletionsFinishReasonOutput | null;
+    index: number;
+    message: ChatResponseMessageOutput;
+}
+
+// @public
+export interface ChatCompletionsNamedToolChoice {
+    function: ChatCompletionsNamedToolChoiceFunction;
+    type: "function";
+}
+
+// @public
+export interface ChatCompletionsNamedToolChoiceFunction {
+    name: string;
+}
+
+// @public
+export interface ChatCompletionsOutput {
+    choices: Array<ChatChoiceOutput>;
+    created: number;
+    id: string;
+    model: string;
+    usage: CompletionsUsageOutput;
+}
+
+// @public
+export type ChatCompletionsResponseFormat = ChatCompletionsResponseFormatParent | ChatCompletionsResponseFormatText | ChatCompletionsResponseFormatJsonObject | ChatCompletionsResponseFormatJsonSchema;
+
+// @public
+export interface ChatCompletionsResponseFormatJsonObject extends ChatCompletionsResponseFormatParent {
+    type: "json_object";
+}
+
+// @public
+export interface ChatCompletionsResponseFormatJsonSchema extends ChatCompletionsResponseFormatParent {
+    json_schema: ChatCompletionsResponseFormatJsonSchemaDefinition;
+    type: "json_schema";
+}
+
+// @public
+export interface ChatCompletionsResponseFormatJsonSchemaDefinition {
+    description?: string;
+    name: string;
+    schema: Record<string, unknown>;
+    strict?: boolean;
+}
+
+// @public
+export interface ChatCompletionsResponseFormatParent {
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface ChatCompletionsResponseFormatText extends ChatCompletionsResponseFormatParent {
+    type: "text";
+}
+
+// @public
+export interface ChatCompletionsToolCall {
+    function: FunctionCall;
+    id: string;
+    type: "function";
+}
+
+// @public
+export interface ChatCompletionsToolCallOutput {
+    function: FunctionCallOutput;
+    id: string;
+    type: "function";
+}
+
+// @public
+export type ChatCompletionsToolChoicePreset = string;
+
+// @public
+export interface ChatCompletionsToolDefinition {
+    function: FunctionDefinition;
+    type: "function";
+}
+
+// @public
+export interface ChatMessageAudioDataContentItem extends ChatMessageContentItemParent {
+    input_audio: ChatMessageInputAudio;
+    type: "input_audio";
+}
+
+// @public
+export interface ChatMessageAudioUrlContentItem extends ChatMessageContentItemParent {
+    audio_url: ChatMessageInputAudioUrl;
+    type: "audio_url";
+}
+
+// @public
+export type ChatMessageContentItem = ChatMessageContentItemParent | ChatMessageTextContentItem | ChatMessageImageContentItem | ChatMessageAudioUrlContentItem | ChatMessageAudioDataContentItem;
+
+// @public
+export interface ChatMessageContentItemParent {
+    // (undocumented)
+    type: string;
+}
+
+// @public
+export interface ChatMessageImageContentItem extends ChatMessageContentItemParent {
+    image_url: ChatMessageImageUrl;
+    type: "image_url";
+}
+
+// @public
+export type ChatMessageImageDetailLevel = string;
+
+// @public
+export interface ChatMessageImageUrl {
+    detail?: ChatMessageImageDetailLevel;
+    url: string;
+}
+
+// @public
+export interface ChatMessageInputAudio {
+    data: string;
+    format: AudioContentFormat;
+}
+
+// @public
+export interface ChatMessageInputAudioUrl {
+    url: string;
+}
+
+// @public
+export interface ChatMessageTextContentItem extends ChatMessageContentItemParent {
+    text: string;
+    type: "text";
+}
+
+// @public
+export interface ChatRequestAssistantMessage extends ChatRequestMessageParent {
+    content?: string;
+    role: "assistant";
+    tool_calls?: Array<ChatCompletionsToolCall>;
+}
+
+// @public
+export interface ChatRequestDeveloperMessage extends ChatRequestMessageParent {
+    content: string;
+    role: "developer";
+}
+
+// @public
+export type ChatRequestMessage = ChatRequestMessageParent | ChatRequestSystemMessage | ChatRequestDeveloperMessage | ChatRequestUserMessage | ChatRequestAssistantMessage | ChatRequestToolMessage;
+
+// @public
+export interface ChatRequestMessageParent {
+    // (undocumented)
+    role: ChatRole;
+}
+
+// @public
+export interface ChatRequestSystemMessage extends ChatRequestMessageParent {
+    content: string;
+    role: "system";
+}
+
+// @public
+export interface ChatRequestToolMessage extends ChatRequestMessageParent {
+    content?: string;
+    role: "tool";
+    tool_call_id: string;
+}
+
+// @public
+export interface ChatRequestUserMessage extends ChatRequestMessageParent {
+    content: string | Array<ChatMessageContentItem>;
+    role: "user";
+}
+
+// @public
+export interface ChatResponseMessageOutput {
+    content: string | null;
+    role: ChatRoleOutput;
+    tool_calls?: Array<ChatCompletionsToolCallOutput>;
+}
+
+// @public
+export type ChatRole = string;
+
+// @public
+export type ChatRoleOutput = string;
+
+// @public
+export type CompletionsFinishReasonOutput = string;
+
+// @public
+export interface CompletionsUsageOutput {
+    completion_tokens: number;
+    prompt_tokens: number;
+    total_tokens: number;
+}
+
+// @public
+function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, { apiVersion, ...options }?: ModelClientOptions): ModelClient;
+export default createClient;
+
+// @public
+export type EmbeddingEncodingFormat = string;
+
+// @public
+export type EmbeddingInputType = string;
+
+// @public
+export interface EmbeddingItemOutput {
+    embedding: string | number[];
+    index: number;
+}
+
+// @public
+export interface EmbeddingsResultOutput {
+    data: Array<EmbeddingItemOutput>;
+    id: string;
+    model: string;
+    usage: EmbeddingsUsageOutput;
+}
+
+// @public
+export interface EmbeddingsUsageOutput {
+    prompt_tokens: number;
+    total_tokens: number;
+}
+
+export { ErrorModel }
+
+// @public
+export type ExtraParameters = string;
+
+// @public
+export interface FunctionCall {
+    arguments: string;
+    name: string;
+}
+
+// @public
+export interface FunctionCallOutput {
+    arguments: string;
+    name: string;
+}
+
+// @public
+export interface FunctionDefinition {
+    description?: string;
+    name: string;
+    parameters?: unknown;
+}
+
+// @public (undocumented)
+export interface GetChatCompletions {
+    post(options: GetChatCompletionsParameters): StreamableMethod<GetChatCompletions200Response | GetChatCompletionsDefaultResponse>;
+}
+
+// @public
+export interface GetChatCompletions200Response extends HttpResponse {
+    // (undocumented)
+    body: ChatCompletionsOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface GetChatCompletionsBodyParam {
+    // (undocumented)
+    body: {
+        messages: Array<ChatRequestMessage>;
+        frequency_penalty?: number;
+        stream?: boolean;
+        presence_penalty?: number;
+        temperature?: number;
+        top_p?: number;
+        max_tokens?: number;
+        response_format?: ChatCompletionsResponseFormat;
+        stop?: string[];
+        tools?: Array<ChatCompletionsToolDefinition>;
+        tool_choice?: ChatCompletionsToolChoicePreset | ChatCompletionsNamedToolChoice;
+        seed?: number;
+        model?: string;
+    };
+}
+
+// @public (undocumented)
+export interface GetChatCompletionsDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface GetChatCompletionsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & GetChatCompletionsDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface GetChatCompletionsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetChatCompletionsHeaders;
+}
+
+// @public (undocumented)
+export interface GetChatCompletionsHeaders {
+    "extra-parameters"?: ExtraParameters;
+}
+
+// @public (undocumented)
+export type GetChatCompletionsParameters = GetChatCompletionsHeaderParam & GetChatCompletionsBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface GetEmbeddings {
+    post(options: GetEmbeddingsParameters): StreamableMethod<GetEmbeddings200Response | GetEmbeddingsDefaultResponse>;
+}
+
+// @public
+export interface GetEmbeddings200Response extends HttpResponse {
+    // (undocumented)
+    body: EmbeddingsResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface GetEmbeddingsBodyParam {
+    // (undocumented)
+    body?: {
+        input: string[];
+        dimensions?: number;
+        encoding_format?: EmbeddingEncodingFormat;
+        input_type?: EmbeddingInputType;
+        model?: string;
+    };
+}
+
+// @public (undocumented)
+export interface GetEmbeddingsDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface GetEmbeddingsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & GetEmbeddingsDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface GetEmbeddingsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetEmbeddingsHeaders;
+}
+
+// @public (undocumented)
+export interface GetEmbeddingsHeaders {
+    "extra-parameters"?: ExtraParameters;
+}
+
+// @public (undocumented)
+export type GetEmbeddingsParameters = GetEmbeddingsHeaderParam & GetEmbeddingsBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface GetImageEmbeddings {
+    post(options: GetImageEmbeddingsParameters): StreamableMethod<GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse>;
+}
+
+// @public
+export interface GetImageEmbeddings200Response extends HttpResponse {
+    // (undocumented)
+    body: EmbeddingsResultOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface GetImageEmbeddingsBodyParam {
+    // (undocumented)
+    body: {
+        input: Array<ImageEmbeddingInput>;
+        dimensions?: number;
+        encoding_format?: EmbeddingEncodingFormat;
+        input_type?: EmbeddingInputType;
+        model?: string;
+    };
+}
+
+// @public (undocumented)
+export interface GetImageEmbeddingsDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface GetImageEmbeddingsDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & GetImageEmbeddingsDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export interface GetImageEmbeddingsHeaderParam {
+    // (undocumented)
+    headers?: RawHttpHeadersInput & GetImageEmbeddingsHeaders;
+}
+
+// @public (undocumented)
+export interface GetImageEmbeddingsHeaders {
+    "extra-parameters"?: ExtraParameters;
+}
+
+// @public (undocumented)
+export type GetImageEmbeddingsParameters = GetImageEmbeddingsHeaderParam & GetImageEmbeddingsBodyParam & RequestParameters;
+
+// @public (undocumented)
+export interface GetModelInfo {
+    get(options?: GetModelInfoParameters): StreamableMethod<GetModelInfo200Response | GetModelInfoDefaultResponse>;
+}
+
+// @public
+export interface GetModelInfo200Response extends HttpResponse {
+    // (undocumented)
+    body: ModelInfoOutput;
+    // (undocumented)
+    status: "200";
+}
+
+// @public (undocumented)
+export interface GetModelInfoDefaultHeaders {
+    "x-ms-error-code"?: string;
+}
+
+// @public (undocumented)
+export interface GetModelInfoDefaultResponse extends HttpResponse {
+    // (undocumented)
+    body: ErrorResponse;
+    // (undocumented)
+    headers: RawHttpHeaders & GetModelInfoDefaultHeaders;
+    // (undocumented)
+    status: string;
+}
+
+// @public (undocumented)
+export type GetModelInfoParameters = RequestParameters;
+
+// @public
+export interface ImageEmbeddingInput {
+    image: string;
+    text?: string;
+}
+
+// @public (undocumented)
+export function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response is GetChatCompletionsDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response is GetModelInfoDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response is GetEmbeddingsDefaultResponse;
+
+// @public (undocumented)
+export function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response is GetImageEmbeddingsDefaultResponse;
+
+// @public (undocumented)
+export type ModelClient = Client & {
+    path: Routes;
+};
+
+// @public
+export interface ModelClientOptions extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface ModelInfoOutput {
+    model_name: string;
+    model_provider_name: string;
+    model_type: ModelTypeOutput;
+}
+
+// @public
+export type ModelTypeOutput = string;
+
+// @public (undocumented)
+export interface Routes {
+    (path: "/chat/completions"): GetChatCompletions;
+    (path: "/info"): GetModelInfo;
+    (path: "/embeddings"): GetEmbeddings;
+    (path: "/images/embeddings"): GetImageEmbeddings;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```