@azure-rest/ai-inference 1.0.0-beta.1 → 1.0.0-beta.3

package/review/ai-inference.api.md

@@ -1,343 +0,0 @@
-## 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 { Client } from '@azure-rest/core-client';
-import { ClientOptions } from '@azure-rest/core-client';
-import { ErrorResponse } from '@azure-rest/core-client';
-import { HttpResponse } from '@azure-rest/core-client';
-import { KeyCredential } from '@azure/core-auth';
-import { RawHttpHeaders } from '@azure/core-rest-pipeline';
-import { RawHttpHeadersInput } from '@azure/core-rest-pipeline';
-import { RequestParameters } from '@azure-rest/core-client';
-import { StreamableMethod } from '@azure-rest/core-client';
-import { TokenCredential } from '@azure/core-auth';
-
-// @public
-export interface ChatChoiceOutput {
-    finish_reason: CompletionsFinishReasonOutput | null;
-    index: number;
-    message: ChatResponseMessageOutput;
-}
-
-// @public
-export interface ChatCompletionsFunctionToolCall extends ChatCompletionsToolCallParent {
-    function: FunctionCall;
-    type: "function";
-}
-
-// @public
-export interface ChatCompletionsFunctionToolCallOutput extends ChatCompletionsToolCallOutputParent {
-    function: FunctionCallOutput;
-    type: "function";
-}
-
-// @public
-export interface ChatCompletionsFunctionToolDefinition extends ChatCompletionsToolDefinitionParent {
-    function: FunctionDefinition;
-    type: "function";
-}
-
-// @public
-export interface ChatCompletionsFunctionToolSelection {
-    name: string;
-}
-
-// @public
-export interface ChatCompletionsNamedFunctionToolSelection extends ChatCompletionsNamedToolSelectionParent {
-    function: ChatCompletionsFunctionToolSelection;
-    type: "function";
-}
-
-// @public
-export type ChatCompletionsNamedToolSelection = ChatCompletionsNamedToolSelectionParent | ChatCompletionsNamedFunctionToolSelection;
-
-// @public
-export interface ChatCompletionsNamedToolSelectionParent {
-    // (undocumented)
-    type: string;
-}
-
-// @public
-export interface ChatCompletionsOutput {
-    choices: Array<ChatChoiceOutput>;
-    created: number;
-    id: string;
-    model: string;
-    usage: CompletionsUsageOutput;
-}
-
-// @public
-export type ChatCompletionsResponseFormat = string | "text" | "json_object";
-
-// @public
-export type ChatCompletionsToolCall = ChatCompletionsToolCallParent | ChatCompletionsFunctionToolCall;
-
-// @public
-export type ChatCompletionsToolCallOutput = ChatCompletionsToolCallOutputParent | ChatCompletionsFunctionToolCallOutput;
-
-// @public
-export interface ChatCompletionsToolCallOutputParent {
-    id: string;
-    // (undocumented)
-    type: string;
-}
-
-// @public
-export interface ChatCompletionsToolCallParent {
-    id: string;
-    // (undocumented)
-    type: string;
-}
-
-// @public
-export type ChatCompletionsToolDefinition = ChatCompletionsToolDefinitionParent | ChatCompletionsFunctionToolDefinition;
-
-// @public
-export interface ChatCompletionsToolDefinitionParent {
-    // (undocumented)
-    type: string;
-}
-
-// @public
-export type ChatCompletionsToolSelectionPreset = string | "auto" | "none" | "required";
-
-// @public
-export type ChatMessageContentItem = ChatMessageContentItemParent | ChatMessageTextContentItem | ChatMessageImageContentItem;
-
-// @public
-export interface ChatMessageContentItemParent {
-    // (undocumented)
-    type: string;
-}
-
-// @public
-export interface ChatMessageImageContentItem extends ChatMessageContentItemParent {
-    image_url: ChatMessageImageUrl;
-    type: "image_url";
-}
-
-// @public
-export type ChatMessageImageDetailLevel = string | "auto" | "low" | "high";
-
-// @public
-export interface ChatMessageImageUrl {
-    detail?: ChatMessageImageDetailLevel;
-    url: string;
-}
-
-// @public
-export interface ChatMessageTextContentItem extends ChatMessageContentItemParent {
-    text: string;
-    type: "text";
-}
-
-// @public
-export interface ChatRequestAssistantMessage extends ChatRequestMessageParent {
-    content?: string | null;
-    role: "assistant";
-    tool_calls?: Array<ChatCompletionsToolCall>;
-}
-
-// @public
-export type ChatRequestMessage = ChatRequestMessageParent | ChatRequestSystemMessage | 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 | null;
-    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 | "system" | "user" | "assistant" | "tool";
-
-// @public
-export type ChatRoleOutput = string | "system" | "user" | "assistant" | "tool";
-
-// @public
-export type CompletionsFinishReasonOutput = string | "stop" | "length" | "content_filter" | "tool_calls";
-
-// @public
-export interface CompletionsUsageOutput {
-    completion_tokens: number;
-    prompt_tokens: number;
-    total_tokens: number;
-}
-
-// @public
-function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): ModelClient;
-export default createClient;
-
-// @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?: ChatCompletionsToolSelectionPreset | ChatCompletionsNamedToolSelection;
-        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 {
-    "unknown-parameters"?: UnknownParams;
-}
-
-// @public (undocumented)
-export type GetChatCompletionsParameters = GetChatCompletionsHeaderParam & GetChatCompletionsBodyParam & 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 (undocumented)
-export function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response is GetChatCompletionsDefaultResponse;
-
-// @public (undocumented)
-export function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response is GetModelInfoDefaultResponse;
-
-// @public (undocumented)
-export type ModelClient = Client & {
-    path: Routes;
-};
-
-// @public
-export interface ModelInfoOutput {
-    model_name: string;
-    model_provider_name: string;
-    model_type: ModelTypeOutput;
-}
-
-// @public
-export type ModelTypeOutput = string | "embeddings" | "image_generation" | "text_generation" | "image_embeddings" | "audio_generation" | "chat";
-
-// @public (undocumented)
-export interface Routes {
-    (path: "/chat/completions"): GetChatCompletions;
-    (path: "/info"): GetModelInfo;
-}
-
-// @public
-export type UnknownParams = string | "error" | "drop" | "pass_through";
-
-// (No @packageDocumentation comment for this package)
-
-```