Corpora

メソッド: corpora.create

空の Corpus を作成します。

エンドポイント

投稿 https://generativelanguage.googleapis.com/v1beta/corpora

リクエストの本文

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

フィールド
name string

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

displayName string

省略可。Corpus の人が読める表示名。表示名は、スペースを含めて 512 文字以下にする必要があります。例: 「セマンティック リトリーバーに関するドキュメント」

レスポンスの本文

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

メソッド: corpora.query

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

エンドポイント

投稿 https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

パスパラメータ

name string

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

リクエストの本文

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

フィールド
query string

必須。セマンティック検索を実行するクエリ文字列。

metadataFilters[] object (MetadataFilter)

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

ドキュメント レベルのクエリの例: (year >= 2020 OR year < 2010) AND (genre = drama 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 = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

注: 同じキーの「AND」は数値でのみサポートされます。文字列値は、同じキーの「OR」のみをサポートします。

resultsCount integer

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

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

レスポンスの本文

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

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

フィールド
relevantChunks[] object (RelevantChunk)

関連するチャンク。

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

メソッド: corpora.list

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

エンドポイント

get https://generativelanguage.googleapis.com/v1beta/corpora

クエリ パラメータ

pageSize integer

省略可。返される Corpora の最大数（ページごと）。サービスが返す Corpora の数は、これより少ない場合があります。

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

pageToken string

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

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

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

リクエストの本文

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

レスポンスの本文

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

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

フィールド
corpora[] object (Corpus)

返されるコーパス。

nextPageToken string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、それ以上ページは取得されません。

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

メソッド: corpora.get

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

エンドポイント

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

パスパラメータ

name string

必須。Corpus の名前。例: corpora/my-corpus-123 形式は corpora/{corpora} です。

リクエストの本文

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

レスポンスの本文

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

メソッド: corpora.patch

Corpus を更新します。

エンドポイント

パッチ 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 の先頭または末尾にダッシュを使用することはできません。作成時に名前が空の場合、displayName と 12 文字のランダムな接尾辞から一意の名前が派生します。例: corpora/my-awesome-corpora-123a456b789c 形式は corpora/{corpora} です。

クエリ パラメータ

updateMask string (FieldMask format)

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

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

リクエストの本文

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

フィールド
displayName string

省略可。Corpus の人が読める表示名。表示名は、スペースを含めて 512 文字以下にする必要があります。例: 「セマンティック リトリーバーに関するドキュメント」

レスポンスの本文

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

メソッド: corpora.delete

Corpus を削除します。

エンドポイント

削除 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 エラーが返されます。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文は空の JSON オブジェクトになります。

REST リソース: corpora.permissions

リソース: Permission

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

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

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

  • リーダーは推論にリソース（チューニング済みモデル、コーパスなど）を使用できる
  • ライターはリーダーの権限を持ち、さらに編集と共有を行うことができます
  • オーナーは書き込み権限を持ち、さらに削除もできる
フィールド
name string

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

granteeType enum (GranteeType)

省略可。変更不可。権限付与対象のタイプ。

emailAddress string

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

role enum (Role)

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

JSON 表現 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

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

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

ロール

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

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

MetadataFilter

ユーザーが指定したフィルタ。Chunk または Document レベルのメタデータ値に基づいて取得を制限します。例（genre = drama OR genre = action）: key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]

フィールド
key string

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

conditions[] object (Condition)

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

JSON 表現 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

条件

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

フィールド
operation enum (Operator)

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

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

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

numericValue number

メタデータのフィルタリングに使用する数値。

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

  // value
  "stringValue": string,
  "numericValue": number
  // Union type
}

演算子

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

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

RelevantChunk

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

フィールド
chunkRelevanceScore number

Chunk 検索語句との関連性。

chunk object (Chunk)

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

document object (Document)

チャンクに関連付けられた Document。

JSON 表現 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  },
  "document": {
    object (Document)
  }
}

REST リソース: corpora

リソース: Corpus

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

フィールド
name string

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

displayName string

省略可。Corpus の人が読める表示名。表示名は、スペースを含めて 512 文字以下にする必要があります。例: 「セマンティック リトリーバーに関するドキュメント」

createTime string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

updateTime string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}