Corpora

REST リソース: corpora

リソース: Corpus

Corpus は Document の集合です。1 つのプロジェクトで最大 5 つのコーパスを作成できます。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}
<ph type="x-smartling-placeholder">
</ph> フィールド
name string

変更不可。ID。Corpus リソース名。ID（「corpora/」を除く名前）の最大文字数は、小文字の英数字またはダッシュ（-）で 40 文字です。ID の先頭または末尾をダッシュにすることはできません。作成時に名前が空の場合、12 文字のランダムな接尾辞とともに、displayName から一意の名前が取得されます。例: corpora/my-awesome-corpora-123a456b789c

displayName string

省略可。Corpus の、人が読める形式の表示名。表示名の長さは、スペースを含めて 512 文字以下にする必要があります。例: 「Docs on Semantic Retriever」

createTime string (Timestamp format)

出力専用。Corpus が作成されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

updateTime string (Timestamp format)

出力専用。Corpus が最後に更新されたときのタイムスタンプ。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

メソッド: corpora.create

空の Corpus を作成します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 https://generativelanguage.googleapis.com/v1beta/corpora

リクエスト本文

リクエストの本文には Corpus のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には、新しく作成された Corpus のインスタンスが含まれます。

メソッド: corpora.list

ユーザーが所有するすべての Corpora を一覧表示します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 入手 https://generativelanguage.googleapis.com/v1beta/corpora

クエリ パラメータ

pageSize integer

省略可。返される Corpora の最大数（1 ページあたり）。サービスが返す Corpora の数が減る場合があります。

指定しない場合、最大で 10 個の Corpora が返されます。サイズの上限は 1 ページあたり 20 Corpora です。

pageToken string

省略可。前回の corpora.list 呼び出しから受け取ったページトークン。

次のページを取得するには、レスポンスで返された nextPageToken を次のリクエストの引数として指定します。

ページ分割を行う場合、corpora.list に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

Corpora のページ分けされたリストを含む corpora.list からのレスポンス。結果は corpus.create_time の昇順で並べ替えられます。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
corpora[] object (Corpus)

返されたコーパス。

nextPageToken string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、ページがなくなります。

JSON 表現 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

メソッド: corpora.query

Corpus に対してセマンティック検索を行います。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 投稿 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

パスパラメータ

name string

必須。クエリする Corpus の名前。例: corpora/my-corpus-123 corpora/{corpora} の形式になります。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
query string

必須。セマンティック検索を行うためのクエリ文字列。

metadataFilters[] object (MetadataFilter)

省略可。Chunk メタデータと Document メタデータをフィルタします。各 MetadataFilter オブジェクトは一意のキーに対応している必要があります。複数の MetadataFilter オブジェクトは論理「AND」で結合されます。

ドキュメント レベルのクエリの例: (year >= 2020 OR year < 2010) AND (genre = control OR genre = action)

MetadataFilter オブジェクト リスト: metadataFilters = [ {key = "document.custom_metadata.year"conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year"conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre"conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

チャンクレベルでの値の範囲に対するクエリの例: (year > 2015 AND year <= 2020)

MetadataFilter オブジェクト リスト: metadataFilters = [ {key = "chunk.custom_metadata.year"conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot;conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

注: 同じキーに対する「AND」は数値に対してのみサポートされています。文字列値の場合、同じキーに対して「OR」のみ使用できます。

resultsCount integer

省略可。返される Chunk の最大数。サービスは、返される Chunk の数が少なくなる場合があります。

指定しない場合、最大で 10 個の Chunk が返されます。指定できる結果の最大数は 100 です。

レスポンスの本文

関連するチャンクのリストを含む corpora.query からのレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

<ph type="x-smartling-placeholder">
</ph> フィールド
relevantChunks[] object (RelevantChunk)

関連するチャンク。

JSON 表現 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

メソッド: corpora.get

特定の Corpus に関する情報を取得します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 入手 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

パスパラメータ

name string

必須。Corpus の名前。例: corpora/my-corpus-123 corpora/{corpora} の形式になります。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Corpus のインスタンスが含まれます。

メソッド: corpora.patch

Corpus を更新します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> パッチ https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

パスパラメータ

corpus.name string

変更不可。ID。Corpus リソース名。ID（「corpora/」を除く名前）の最大文字数は、小文字の英数字またはダッシュ（-）で 40 文字です。ID の先頭または末尾をダッシュにすることはできません。作成時に名前が空の場合、12 文字のランダムな接尾辞とともに、displayName から一意の名前が取得されます。例: corpora/my-awesome-corpora-123a456b789c corpora/{corpora} の形式になります。

クエリ パラメータ

updateMask string (FieldMask format)

必須。更新するフィールドのリスト。現在、これは displayName の更新のみをサポートしています。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Corpus のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Corpus のインスタンスが含まれます。

メソッド: corpora.delete

Corpus を削除します。

エンドポイント

<ph type="x-smartling-placeholder"></ph> <ph type="x-smartling-placeholder"></ph> 削除 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

パスパラメータ

name string

必須。Corpus のリソース名。例: corpora/my-corpus-123 corpora/{corpora} の形式になります。

クエリ パラメータ

force boolean

省略可。true に設定すると、この Corpus に関連する Document とオブジェクトも削除されます。

false（デフォルト）の場合、Corpus に Document が含まれていると、FAILED_PRECONDITION エラーが返されます。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文は空になります。

REST リソース: corpora.permissions

リソース: Permission

権限リソースは、ユーザー、グループ、その他のユーザーに PaLM API リソース（チューニング済みモデル、コーパスなど）へのアクセス権を付与します。

ロールとは、ユーザーが PaLM API リソースに対して特定の操作を実行できるようにする、許可された操作のコレクションです。ユーザー、グループ、サービス アカウントで使用できるようにするには、ロールを割り当てます。ロールを割り当てると、そのロールに含まれる権限が付与されます。

同心円状のロールが 3 つあります。各ロールは、前のロールで許可されているオペレーションのスーパーセットです。

  • リーダーはリソース（チューニング済みモデル、コーパスなど）を推論に使用できる
  • 作成者は読者の権限を持ち、さらに編集と共有を行うことができます
  • オーナーはライターの権限を持ち、さらにオーナーが削除できる
JSON 表現 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
<ph type="x-smartling-placeholder">
</ph> フィールド
name string

出力専用。ID。権限名。作成時に一意の名前が生成されます。例: tuningModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission}。出力のみ。

granteeType enum (GranteeType)

省略可。変更不可。譲受人のタイプ。

emailAddress string

省略可。変更不可。この権限が参照するグループのユーザーのメールアドレス。権限の付与対象タイプが「EVERYONE」の場合、フィールドは設定されません。

role enum (Role)

必須。この権限によって付与されるロール。

GranteeType

この権限の付与先のタイプを定義します。

列挙型
GRANTEE_TYPE_UNSPECIFIED デフォルト値。この値は使用されません。
USER ユーザーを表します。設定する場合は、ユーザーの emailAddress を指定する必要があります。
GROUP グループを表します。設定する場合は、グループの emailAddress を指定する必要があります。
EVERYONE すべてのユーザーのアクセス権を表します。その他の情報は必要ありません。

ロール

この権限によって付与されるロールを定義します。

列挙型
ROLE_UNSPECIFIED デフォルト値。この値は使用されません。
OWNER オーナーはリソースを使用、更新、共有、削除できます。
WRITER ライターは、リソースを使用、更新、共有できます。
READER リーダーがリソースを使用できます。

MetadataFilter

Chunk または Document レベルのメタデータ値に基づいて取得を制限するユーザー指定のフィルタ。例（ジャンル = ドラマ OR ジャンル = アクション）: キー = "document.custom_metadata.genre"conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

JSON 表現 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}
<ph type="x-smartling-placeholder">
</ph> フィールド
key string

必須。フィルタするメタデータのキー。

conditions[] object (Condition)

必須。このフィルタをトリガーする、指定されたキーの Condition。複数の Condition は論理 OR で結合されます。

条件

単一のキーに適用されるフィルタ条件。

JSON 表現 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}
<ph type="x-smartling-placeholder">
</ph> フィールド
operation enum (Operator)

必須。条件をトリガーするために指定された Key-Value ペアに適用される演算子。

共用体フィールド value。値の型は、対応するキーのフィールドで定義されている値の型と一致する必要があります。値の型が一貫していない場合、結果は空セットになります。CustomMetadata の値の型が StringList の場合、フィルタリング条件では string_value と INCLUDES/EXCLUDES オペレーションを組み合わせて使用する必要があります。それ以外の場合は、結果も空セットになります。value は次のいずれかになります。
stringValue string

メタデータをフィルタする文字列値。

numericValue number

メタデータをフィルタする数値。

演算子

Key-Value ペアに適用できる有効な演算子を定義します。

列挙型
OPERATOR_UNSPECIFIED デフォルト値。この値は使用されません。
LESS 数値でサポートされています。
LESS_EQUAL 数値でサポートされています。
EQUAL 数値と使用します。
GREATER_EQUAL 数値でサポートされています。
GREATER 数値でサポートされています。
NOT_EQUAL 数値と使用します。
INCLUDES 指定されたキーの CustomMetadata 値の型に stringListValue がある場合にのみ、文字列でサポートされます。
EXCLUDES 指定されたキーの CustomMetadata 値の型に stringListValue がある場合にのみ、文字列でサポートされます。

RelevantChunk

クエリに関連するチャンクの情報。

JSON 表現 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}
<ph type="x-smartling-placeholder">
</ph> フィールド
chunkRelevanceScore number

Chunk: クエリとの関連性。

chunk object (Chunk)

クエリに関連付けられた Chunk。