# General Translation Platform: EntryMetadata
URL: https://generaltranslation.com/ja/docs/platform/core/reference/types/entry-metadata.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: ランタイム翻訳エントリにコンテキストと処理制御を追加します。EntryMetadata と RuntimeFileFormat の API リファレンス。

`EntryMetadata` は [`TranslateManyEntry`](/docs/platform/core/reference/types/translate-many-entry) オブジェクトに対するオプション設定を提供し、General Translation がエントリをどのように翻訳するかを調整するためのコンテキストや制御を追加します。

## 概要 [#overview]

`EntryMetadata` は、オブジェクト形式の翻訳エントリにおける `metadata` フィールドです。すべてのフィールドは任意です。

```typescript
type EntryMetadata = {
  id?: string;
  hash?: string;
  context?: string;
  maxChars?: number;
  dataFormat?: DataFormat;
  fileFormat?: RuntimeFileFormat;
  actionType?: EntryActionType;
};
```

対応する `EntryActionType` は `generaltranslation/types` からインポートします:

```typescript
type EntryActionType = 'fast' | 'standard';
```

## プロパティ [#properties]

| プロパティ                        | 説明                                               | 型                                                               | 任意 |
| ---------------------------- | ------------------------------------------------ | --------------------------------------------------------------- | -- |
| [`id`](#id)                  | エントリを一意に識別する ID。                                 | `string`                                                        | はい |
| [`hash`](#hash)              | キャッシュと重複排除のためのコンテンツのハッシュ値。                       | `string`                                                        | はい |
| [`context`](#context)        | 翻訳者向けのコンテキスト情報。                                  | `string`                                                        | はい |
| [`maxChars`](#max-chars)     | 生成される翻訳の要求された最大長。                                | `number`                                                        | はい |
| [`dataFormat`](#data-format) | コンテンツ形式の指定。                                      | [`DataFormat`](/docs/platform/core/reference/types/data-format) | はい |
| [`fileFormat`](#file-format) | Markdown または MDX ドキュメント全体を、形式を考慮した翻訳の対象として指定します。 | [`RuntimeFileFormat`](#runtime-file-format)                     | はい |
| [`actionType`](#action-type) | 翻訳モデルの指定。                                        | `EntryActionType`                                               | はい |

### `id` [#id]

**型** `string` · **任意**

エントリを一意に識別する ID。

### `hash` [#hash]

**型** `string` · **任意**

キャッシュと重複排除に使用されるコンテンツのハッシュ値。

### `context` [#context]

**型** `string` · **任意**

翻訳者向けのコンテキスト情報です。たとえば `"Button text"` や `"Navigation menu"` などです。

### `maxChars` [#max-chars]

**型** `number` · **任意**

翻訳サービスに正の整数の最大文字数を指定します。その他の数値では上限は適用されません。Core ライブラリは返された翻訳を切り詰めません。

### `dataFormat` [#data-format]

**型** [`DataFormat`](/docs/platform/core/reference/types/data-format) · **任意** · **デフォルト** `'STRING'`

コンテンツ形式の指定: `'JSX'`、`'ICU'`、`'I18NEXT'`、または `'STRING'`。 省略した場合は `'STRING'` になります。 ([`DataFormat`](/docs/platform/core/reference/types/data-format) を参照してください) 。

### `fileFormat` [#file-format]

**型** `RuntimeFileFormat` · **任意**

`source` に Markdown または MDX のドキュメント全体が含まれる場合は、これを `'MD'` または `'MDX'` に設定します。実行時、サービスはドキュメントのエントリに対して、データ形式に `STRING` を使用し、`maxChars` を省略することを要求します。

サービスはドキュメントを解析してチャンクに分割し、各チャンクにエントリの `context` を付加します。返されるのは構造を保持した 1 つの文字列です。いずれかのチャンクが失敗した場合、または最終的なドキュメントが不正な場合は、部分的な出力を返すのではなく、そのエントリ自体が失敗します。

`fileFormat` はリクエストの識別情報の一部であるため、それ以外が同一のプレーンテキスト、Markdown、MDX のエントリは、それぞれ別々のキャッシュされた翻訳を使用します。

### `actionType` [#action-type]

**型** `EntryActionType` · **任意**

翻訳アクションの指定です。`'fast'` または `'standard'` を指定できます。このフィールドは、エントリの `metadata` 内にネストしたままにしてください。

## `RuntimeFileFormat` [#runtime-file-format]

**型** `'MD' | 'MDX'`

この型は `generaltranslation/types` からインポートします。ランタイムの [`translate`](/docs/platform/core/reference/gt-class-methods/translation/translate) および [`translateMany`](/docs/platform/core/reference/gt-class-methods/translation/translate-many) の呼び出しで受け付けられるドキュメント形式のみが含まれます。

## 例 [#example]

```typescript
import { GT } from 'generaltranslation';
import type { TranslateManyEntry } from 'generaltranslation/types';

const entry: TranslateManyEntry = {
  source: 'Save',
  metadata: {
    context: 'Button text',
    actionType: 'fast'
  }
};

const gt = new GT({ apiKey: 'your-api-key', projectId: 'your-project-id' });
const result = await gt.translate(entry, 'es');
```

```typescript
// ICU形式の場合
const entry: TranslateManyEntry = {
  source: '{count, plural, other {{count} items}}',
  metadata: {
    dataFormat: 'ICU',
    context: 'Item count'
  }
};
```

```typescript
// 構造を保持したまま、Markdownドキュメント全体を翻訳します。
const document: TranslateManyEntry = {
  source: '# Welcome\n\nRead the [guide](/guide).',
  metadata: {
    fileFormat: 'MD',
  },
};

const [result] = await gt.translateMany([document], {
  sourceLocale: 'en',
  targetLocale: 'es',
});
```

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.