@azure-rest/ai-translation-document 1.0.0-beta.2 → 1.0.0

package/types/ai-translation-document.d.ts

@@ -1,25 +1,19 @@
-/// <reference types="node" />
-
-import { AbortSignalLike } from '@azure/abort-controller';
-import { CancelOnProgress } from '@azure/core-lro';
-import { Client } from '@azure-rest/core-client';
-import { ClientOptions } from '@azure-rest/core-client';
-import { createFile } from '@azure/core-rest-pipeline';
-import { createFileFromStream } from '@azure/core-rest-pipeline';
-import { CreateFileFromStreamOptions } from '@azure/core-rest-pipeline';
-import { CreateFileOptions } from '@azure/core-rest-pipeline';
-import { CreateHttpPollerOptions } from '@azure/core-lro';
-import { ErrorResponse } from '@azure-rest/core-client';
-import { HttpResponse } from '@azure-rest/core-client';
-import { KeyCredential } from '@azure/core-auth';
-import { OperationState } from '@azure/core-lro';
-import { PagedAsyncIterableIterator } from '@azure/core-paging';
-import { PathUncheckedResponse } from '@azure-rest/core-client';
-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';
+import type { AbortSignalLike } from '@azure/abort-controller';
+import type { CancelOnProgress } from '@azure/core-lro';
+import type { Client } from '@azure-rest/core-client';
+import type { ClientOptions } from '@azure-rest/core-client';
+import type { CreateHttpPollerOptions } from '@azure/core-lro';
+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 { OperationState } from '@azure/core-lro';
+import type { PagedAsyncIterableIterator } from '@azure/core-paging';
+import type { PathUncheckedResponse } from '@azure-rest/core-client';
+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';
 
 /** Definition for the input batch translation request */
 export declare interface BatchRequest {
@@ -27,7 +21,11 @@ export declare interface BatchRequest {
     source: SourceInput;
     /** Location of the destination for the output */
     targets: Array<TargetInput>;
-    /** Storage type of the input documents source string */
+    /**
+     * Storage type of the input documents source string
+     *
+     * Possible values: "Folder", "File"
+     */
     storageType?: StorageInputType;
 }
 
@@ -56,17 +54,9 @@ export declare type CancelTranslationParameters = RequestParameters;
  * @param credentials - uniquely identify client credential
  * @param options - the parameter for all optional parameters
  */
-declare function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentTranslationClient;
+declare function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, { apiVersion, ...options }?: DocumentTranslationClientOptions): DocumentTranslationClient;
 export default createClient;
 
-export { createFile }
-
-export { createFileFromStream }
-
-export { CreateFileFromStreamOptions }
-
-export { CreateFileOptions }
-
 /** Document filter */
 export declare interface DocumentFilter {
     /**
@@ -102,7 +92,11 @@ export declare interface DocumentStatusOutput {
     createdDateTimeUtc: string;
     /** Date time in which the operation's status has been updated */
     lastActionDateTimeUtc: string;
-    /** List of possible statuses for job or document */
+    /**
+     * List of possible statuses for job or document
+     *
+     * Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", "ValidationFailed"
+     */
     status: StatusOutput;
     /** To language */
     to: string;
@@ -127,6 +121,8 @@ export declare interface DocumentTranslate {
 export declare interface DocumentTranslate200Headers {
     /** An opaque, globally-unique, client-generated string identifier for the request. */
     "x-ms-client-request-id"?: string;
+    /** response content type */
+    "content-type": "application/octet-stream";
 }
 
 /** The request has succeeded. */
@@ -138,7 +134,8 @@ export declare interface DocumentTranslate200Response extends HttpResponse {
 }
 
 export declare interface DocumentTranslateBodyParam {
-    body?: DocumentTranslateContent;
+    /** Document Translate Request Content */
+    body: DocumentTranslateContent;
 }
 
 /** Document Translate Request Content */
@@ -219,6 +216,12 @@ export declare type DocumentTranslationClient = Client & {
     path: Routes;
 };
 
+/** The optional parameters for the client */
+export declare interface DocumentTranslationClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+
 /** File Format */
 export declare interface FileFormatOutput {
     /** Name of the format */
@@ -236,7 +239,7 @@ export declare interface FileFormatOutput {
 }
 
 /** Alias for FileFormatType */
-export declare type FileFormatType = "document" | "glossary" | string;
+export declare type FileFormatType = string;
 
 /**
  * Helper type to extract the type of an array
@@ -451,7 +454,11 @@ export declare interface GetSupportedFormatsQueryParam {
 }
 
 export declare interface GetSupportedFormatsQueryParamProperties {
-    /** the type of format like document or glossary */
+    /**
+     * the type of format like document or glossary
+     *
+     * Possible values: "document", "glossary"
+     */
     type?: FileFormatType;
 }
 
@@ -588,7 +595,11 @@ export declare interface Glossary {
     format: string;
     /** Optional Version.  If not specified, default is used. */
     version?: string;
-    /** Storage Source */
+    /**
+     * Storage Source
+     *
+     * Possible values: "AzureBlob"
+     */
     storageSource?: StorageSource;
 }
 
@@ -693,10 +704,6 @@ export declare interface SimplePollerLike<TState extends OperationState<TResult>
      * Returns true if the poller has finished polling.
      */
     isDone(): boolean;
-    /**
-     * Returns true if the poller is stopped.
-     */
-    isStopped(): boolean;
     /**
      * Returns the state of the operation.
      */
@@ -747,6 +754,11 @@ export declare interface SimplePollerLike<TState extends OperationState<TResult>
      * @deprecated Use abortSignal to stop polling instead.
      */
     stopPolling(): void;
+    /**
+     * Returns true if the poller is stopped.
+     * @deprecated Use abortSignal status to track this instead.
+     */
+    isStopped(): boolean;
 }
 
 /** Source of the input documents */
@@ -760,7 +772,11 @@ export declare interface SourceInput {
      * If none is specified, we will perform auto detect on the document
      */
     language?: string;
-    /** Storage Source */
+    /**
+     * Storage Source
+     *
+     * Possible values: "AzureBlob"
+     */
     storageSource?: StorageSource;
 }
 
@@ -786,7 +802,7 @@ export declare interface StartTranslation {
      * destination, it will be overwritten. The targetUrl for each target language
      * must be unique.
      */
-    post(options?: StartTranslationParameters): StreamableMethod<StartTranslation202Response | StartTranslationDefaultResponse>;
+    post(options: StartTranslationParameters): StreamableMethod<StartTranslation202Response | StartTranslationDefaultResponse>;
     /**
      * Returns a list of batch requests submitted and the status for each
      * request.
@@ -856,7 +872,8 @@ export declare interface StartTranslation202Response extends HttpResponse {
 }
 
 export declare interface StartTranslationBodyParam {
-    body?: StartTranslationDetails;
+    /** Translation job submission batch request */
+    body: StartTranslationDetails;
 }
 
 export declare interface StartTranslationDefaultHeaders {
@@ -884,7 +901,7 @@ export declare interface StartTranslationLogicalResponse extends HttpResponse {
 export declare type StartTranslationParameters = StartTranslationBodyParam & RequestParameters;
 
 /** Alias for StatusOutput */
-export declare type StatusOutput = "NotStarted" | "Running" | "Succeeded" | "Failed" | "Cancelled" | "Cancelling" | "ValidationFailed" | string;
+export declare type StatusOutput = string;
 
 /** Status Summary */
 export declare interface StatusSummaryOutput {
@@ -905,10 +922,10 @@ export declare interface StatusSummaryOutput {
 }
 
 /** Alias for StorageInputType */
-export declare type StorageInputType = "Folder" | "File" | string;
+export declare type StorageInputType = string;
 
 /** Alias for StorageSource */
-export declare type StorageSource = "AzureBlob" | string;
+export declare type StorageSource = string;
 
 /** List of supported file formats */
 export declare interface SupportedFileFormatsOutput {
@@ -926,19 +943,27 @@ export declare interface TargetInput {
     language: string;
     /** List of Glossary */
     glossaries?: Array<Glossary>;
-    /** Storage Source */
+    /**
+     * Storage Source
+     *
+     * Possible values: "AzureBlob"
+     */
     storageSource?: StorageSource;
 }
 
 /** Alias for TranslationErrorCodeOutput */
-export declare type TranslationErrorCodeOutput = "InvalidRequest" | "InvalidArgument" | "InternalServerError" | "ServiceUnavailable" | "ResourceNotFound" | "Unauthorized" | "RequestRateTooHigh" | string;
+export declare type TranslationErrorCodeOutput = string;
 
 /**
  * This contains an outer error with error code, message, details, target and an
  * inner error with more descriptive details.
  */
 export declare interface TranslationErrorOutput {
-    /** Enums containing high level error codes. */
+    /**
+     * Enums containing high level error codes.
+     *
+     * Possible values: "InvalidRequest", "InvalidArgument", "InternalServerError", "ServiceUnavailable", "ResourceNotFound", "Unauthorized", "RequestRateTooHigh"
+     */
     code: TranslationErrorCodeOutput;
     /** Gets high level error message. */
     message: string;
@@ -975,7 +1000,11 @@ export declare interface TranslationStatusOutput {
     createdDateTimeUtc: string;
     /** Date time in which the operation's status has been updated */
     lastActionDateTimeUtc: string;
-    /** List of possible statuses for job or document */
+    /**
+     * List of possible statuses for job or document
+     *
+     * Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Cancelled", "Cancelling", "ValidationFailed"
+     */
     status: StatusOutput;
     /**
      * This contains an outer error with error code, message, details, target and an