@azure-rest/ai-document-translator 1.0.0-alpha.20241121.1 → 1.0.0-alpha.20241125.1

package/dist/esm/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/models.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport interface StartTranslationDetails {\n  /** The input list of documents or folders containing documents */\n  inputs: BatchRequest[];\n}\n\nexport interface BatchRequest {\n  /** Source of the input documents */\n  source: SourceInput;\n  /** Location of the destination for the output */\n  targets: TargetInput[];\n  /** Storage type of the input documents source string */\n  storageType?: StorageInputType;\n}\n\nexport interface SourceInput {\n  /** Location of the folder / container or single file with your documents */\n  sourceUrl: string;\n  /** */\n  filter?: DocumentFilter;\n  /**\n   * Language code\n   * If none is specified, we will perform auto detect on the document\n   */\n  language?: string;\n  /** Storage Source */\n  storageSource?: StorageSource;\n}\n\nexport interface DocumentFilter {\n  /**\n   * A case-sensitive prefix string to filter documents in the source path for translation.\n   * For example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation.\n   */\n  prefix?: string;\n  /**\n   * A case-sensitive suffix string to filter documents in the source path for translation.\n   * This is most often use for file extensions\n   */\n  suffix?: string;\n}\n\nexport interface TargetInput {\n  /** Location of the folder / container with your documents */\n  targetUrl: string;\n  /** Category / custom system for translation request */\n  category?: string;\n  /** Target Language */\n  language: string;\n  /** List of Glossary */\n  glossaries?: Glossary[];\n  /** Storage Source */\n  storageSource?: StorageSource;\n}\n\nexport interface Glossary {\n  /**\n   * Location of the glossary.\n   * We will use the file extension to extract the formatting if the format parameter is not supplied.\n   *\n   * If the translation language pair is not present in the glossary, it will not be applied\n   */\n  glossaryUrl: string;\n  /** Format */\n  format: string;\n  /** Optional Version.  If not specified, default is used. */\n  version?: string;\n  /** Storage Source */\n  storageSource?: StorageSource;\n}\n\nexport interface TranslationErrorResponse {\n  /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\n  error?: TranslationError;\n}\n\nexport interface TranslationError {\n  /** Enums containing high level error codes. */\n  code: TranslationErrorCode;\n  /** Gets high level error message. */\n  message: string;\n  /**\n   * Gets the source of the error.\n   * For example it would be \"documents\" or \"document id\" in case of invalid document.\n   */\n  target?: string;\n  /**\n   * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\n   * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).\n   */\n  innerError?: InnerTranslationError;\n}\n\nexport interface InnerTranslationError {\n  /** Gets code error string. */\n  code: string;\n  /** Gets high level error message. */\n  message: string;\n  /**\n   * Gets the source of the error.\n   * For example it would be \"documents\" or \"document id\" in case of invalid document.\n   */\n  target?: string;\n  /**\n   * New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\n   * This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).\n   */\n  innerError?: InnerTranslationError;\n}\n\nexport interface TranslationsStatus {\n  /** The summary status of individual operation */\n  value: TranslationStatus[];\n  /** Url for the next page.  Null if no more pages available */\n  nextLink?: string;\n}\n\nexport interface TranslationStatus {\n  /** Id of the operation. */\n  id: string;\n  /** Operation created date time */\n  createdDateTimeUtc: Date;\n  /** Date time in which the operation's status has been updated */\n  lastActionDateTimeUtc: Date;\n  /** List of possible statuses for job or document */\n  status: Status;\n  /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\n  error?: TranslationError;\n  /** */\n  summary: StatusSummary;\n}\n\nexport interface StatusSummary {\n  /** Total count */\n  total: number;\n  /** Failed count */\n  failed: number;\n  /** Number of Success */\n  success: number;\n  /** Number of in progress */\n  inProgress: number;\n  /** Count of not yet started */\n  notYetStarted: number;\n  /** Number of cancelled */\n  cancelled: number;\n  /** Total characters charged by the API */\n  totalCharacterCharged: number;\n}\n\nexport interface DocumentStatus {\n  /** Location of the document or folder */\n  path?: string;\n  /** Location of the source document */\n  sourcePath: string;\n  /** Operation created date time */\n  createdDateTimeUtc: Date;\n  /** Date time in which the operation's status has been updated */\n  lastActionDateTimeUtc: Date;\n  /** List of possible statuses for job or document */\n  status: Status;\n  /** To language */\n  to: string;\n  /** This contains an outer error with error code, message, details, target and an inner error with more descriptive details. */\n  error?: TranslationError;\n  /** Progress of the translation if available */\n  progress: number;\n  /** Document Id */\n  id: string;\n  /** Character charged by the API */\n  characterCharged?: number;\n}\n\nexport interface DocumentsStatus {\n  /** The detail status of individual documents */\n  value: DocumentStatus[];\n  /** Url for the next page.  Null if no more pages available */\n  nextLink?: string;\n}\n\nexport interface SupportedFileFormats {\n  /** list of objects */\n  value: FileFormat[];\n}\n\nexport interface FileFormat {\n  /** Name of the format */\n  format: string;\n  /** Supported file extension for this format */\n  fileExtensions: string[];\n  /** Supported Content-Types for this format */\n  contentTypes: string[];\n  /** Default version if none is specified */\n  defaultVersion?: string;\n  /** Supported Version */\n  versions?: string[];\n}\n\nexport interface SupportedStorageSources {\n  /** list of objects */\n  value: \"AzureBlob\"[];\n}\n\nexport type StorageSource = \"AzureBlob\";\nexport type StorageInputType = \"Folder\" | \"File\";\nexport type TranslationErrorCode =\n  | \"InvalidRequest\"\n  | \"InvalidArgument\"\n  | \"InternalServerError\"\n  | \"ServiceUnavailable\"\n  | \"ResourceNotFound\"\n  | \"Unauthorized\"\n  | \"RequestRateTooHigh\";\nexport type Status =\n  | \"NotStarted\"\n  | \"Running\"\n  | \"Succeeded\"\n  | \"Failed\"\n  | \"Cancelled\"\n  | \"Cancelling\"\n  | \"ValidationFailed\";\n"]}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/dist/esm/parameters.d.ts

@@ -0,0 +1,93 @@
+import type { RequestParameters } from "@azure-rest/core-client";
+import type { StartTranslationDetails } from "./models.js";
+export interface StartTranslationBodyParam {
+    body: StartTranslationDetails;
+}
+export type StartTranslationParameters = RequestParameters & StartTranslationBodyParam;
+export interface GetTranslationsStatusQueryParamProperties {
+    /**
+     * $top indicates the total number of records the user wants to be returned across all pages.
+     *
+     * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.
+     * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.
+     *
+     * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
+     */
+    $top?: number;
+    /**
+     * $skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified.  By default, we sort by descending start time.
+     *
+     * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.
+     * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.
+     *
+     * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
+     */
+    $skip?: number;
+    /**
+     * $maxpagesize is the maximum items returned in a page.  If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
+     *
+     * Clients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.
+     */
+    $maxpagesize?: number;
+    /** Ids to use in filtering */
+    ids?: string[];
+    /** Statuses to use in filtering */
+    statuses?: string[];
+    /** the start datetime to get items after */
+    createdDateTimeUtcStart?: Date;
+    /** the end datetime to get items before */
+    createdDateTimeUtcEnd?: Date;
+    /** the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc') */
+    $orderBy?: string[];
+}
+export interface GetTranslationsStatusQueryParam {
+    queryParameters?: GetTranslationsStatusQueryParamProperties;
+}
+export type GetTranslationsStatusParameters = RequestParameters & GetTranslationsStatusQueryParam;
+export type GetDocumentStatusParameters = RequestParameters;
+export type GetTranslationStatusParameters = RequestParameters;
+export type CancelTranslationParameters = RequestParameters;
+export interface GetDocumentsStatusQueryParamProperties {
+    /**
+     * $top indicates the total number of records the user wants to be returned across all pages.
+     *
+     * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.
+     * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.
+     *
+     * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
+     */
+    $top?: number;
+    /**
+     * $skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified.  By default, we sort by descending start time.
+     *
+     * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.
+     * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.
+     *
+     * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.
+     */
+    $skip?: number;
+    /**
+     * $maxpagesize is the maximum items returned in a page.  If more items are requested via $top (or $top is not specified and there are more items to be returned), \@nextLink will contain the link to the next page.
+     *
+     * Clients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.
+     */
+    $maxpagesize?: number;
+    /** Ids to use in filtering */
+    ids?: string[];
+    /** Statuses to use in filtering */
+    statuses?: string[];
+    /** the start datetime to get items after */
+    createdDateTimeUtcStart?: Date;
+    /** the end datetime to get items before */
+    createdDateTimeUtcEnd?: Date;
+    /** the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc') */
+    $orderBy?: string[];
+}
+export interface GetDocumentsStatusQueryParam {
+    queryParameters?: GetDocumentsStatusQueryParamProperties;
+}
+export type GetDocumentsStatusParameters = RequestParameters & GetDocumentsStatusQueryParam;
+export type GetSupportedDocumentFormatsParameters = RequestParameters;
+export type GetSupportedGlossaryFormatsParameters = RequestParameters;
+export type GetSupportedStorageSourcesParameters = RequestParameters;
+//# sourceMappingURL=parameters.d.ts.map

package/dist/esm/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAE3D,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,GAAG,yBAAyB,CAAC;AAEvF,MAAM,WAAW,yCAAyC;IACxD;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4CAA4C;IAC5C,uBAAuB,CAAC,EAAE,IAAI,CAAC;IAC/B,2CAA2C;IAC3C,qBAAqB,CAAC,EAAE,IAAI,CAAC;IAC7B,qGAAqG;IACrG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,+BAA+B;IAC9C,eAAe,CAAC,EAAE,yCAAyC,CAAC;CAC7D;AAED,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,GAAG,+BAA+B,CAAC;AAClG,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAC5D,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;AAC/D,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAE5D,MAAM,WAAW,sCAAsC;IACrD;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4CAA4C;IAC5C,uBAAuB,CAAC,EAAE,IAAI,CAAC;IAC/B,2CAA2C;IAC3C,qBAAqB,CAAC,EAAE,IAAI,CAAC;IAC7B,qGAAqG;IACrG,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,4BAA4B;IAC3C,eAAe,CAAC,EAAE,sCAAsC,CAAC;CAC1D;AAED,MAAM,MAAM,4BAA4B,GAAG,iBAAiB,GAAG,4BAA4B,CAAC;AAC5F,MAAM,MAAM,qCAAqC,GAAG,iBAAiB,CAAC;AACtE,MAAM,MAAM,qCAAqC,GAAG,iBAAiB,CAAC;AACtE,MAAM,MAAM,oCAAoC,GAAG,iBAAiB,CAAC"}

package/dist/esm/parameters.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=parameters.js.map

package/dist/esm/parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.js","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { RequestParameters } from \"@azure-rest/core-client\";\nimport type { StartTranslationDetails } from \"./models.js\";\n\nexport interface StartTranslationBodyParam {\n  body: StartTranslationDetails;\n}\n\nexport type StartTranslationParameters = RequestParameters & StartTranslationBodyParam;\n\nexport interface GetTranslationsStatusQueryParamProperties {\n  /**\n   * $top indicates the total number of records the user wants to be returned across all pages.\n   *\n   * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\n   * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\n   *\n   * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.\n   */\n  $top?: number;\n  /**\n   * $skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified.  By default, we sort by descending start time.\n   *\n   * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\n   * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\n   *\n   * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.\n   */\n  $skip?: number;\n  /**\n   * $maxpagesize is the maximum items returned in a page.  If more items are requested via $top (or $top is not specified and there are more items to be returned), \\@nextLink will contain the link to the next page.\n   *\n   * Clients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.\n   */\n  $maxpagesize?: number;\n  /** Ids to use in filtering */\n  ids?: string[];\n  /** Statuses to use in filtering */\n  statuses?: string[];\n  /** the start datetime to get items after */\n  createdDateTimeUtcStart?: Date;\n  /** the end datetime to get items before */\n  createdDateTimeUtcEnd?: Date;\n  /** the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc') */\n  $orderBy?: string[];\n}\n\nexport interface GetTranslationsStatusQueryParam {\n  queryParameters?: GetTranslationsStatusQueryParamProperties;\n}\n\nexport type GetTranslationsStatusParameters = RequestParameters & GetTranslationsStatusQueryParam;\nexport type GetDocumentStatusParameters = RequestParameters;\nexport type GetTranslationStatusParameters = RequestParameters;\nexport type CancelTranslationParameters = RequestParameters;\n\nexport interface GetDocumentsStatusQueryParamProperties {\n  /**\n   * $top indicates the total number of records the user wants to be returned across all pages.\n   *\n   * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\n   * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\n   *\n   * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.\n   */\n  $top?: number;\n  /**\n   * $skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified.  By default, we sort by descending start time.\n   *\n   * Clients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\n   * When both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\n   *\n   * Note: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options.\n   */\n  $skip?: number;\n  /**\n   * $maxpagesize is the maximum items returned in a page.  If more items are requested via $top (or $top is not specified and there are more items to be returned), \\@nextLink will contain the link to the next page.\n   *\n   * Clients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size.\n   */\n  $maxpagesize?: number;\n  /** Ids to use in filtering */\n  ids?: string[];\n  /** Statuses to use in filtering */\n  statuses?: string[];\n  /** the start datetime to get items after */\n  createdDateTimeUtcStart?: Date;\n  /** the end datetime to get items before */\n  createdDateTimeUtcEnd?: Date;\n  /** the sorting query for the collection (ex: 'CreatedDateTimeUtc asc', 'CreatedDateTimeUtc desc') */\n  $orderBy?: string[];\n}\n\nexport interface GetDocumentsStatusQueryParam {\n  queryParameters?: GetDocumentsStatusQueryParamProperties;\n}\n\nexport type GetDocumentsStatusParameters = RequestParameters & GetDocumentsStatusQueryParam;\nexport type GetSupportedDocumentFormatsParameters = RequestParameters;\nexport type GetSupportedGlossaryFormatsParameters = RequestParameters;\nexport type GetSupportedStorageSourcesParameters = RequestParameters;\n"]}