Developer toolchainオントロジー SDKPython オントロジー SDK

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

Python オントロジー SDK

このページでは、Example Restaurant オブジェクトに基づいた Python OSDK の一般的なドキュメンテーションを提供しています。Developer Console でユーザーのオントロジーに特化したドキュメンテーションを生成することも可能です。

プロパティ	API 名	タイプ
レストランID (プライマリーキー)	restaurantId	文字列
レストラン名 (タイトル)	restaurantName	文字列
住所	address	文字列
E メール	eMail	文字列
レビュー数	numberOfReviews	整数
電話番号	phoneNumber	文字列
レビューの概要	reviewSummary	文字列

単一のレストランのロード

パラメーター:

primaryKey string: 取得したい Example Restaurant のプライマリーキー

クエリの例:

Copied!1
2
# "primaryKey"を持つ"ExampleRestaurant"オブジェクトを取得し、その結果を"result"に格納します。
result = client.ontology.objects.ExampleRestaurant.get("primaryKey")

例のAPIレスポンス：

例のレストランのページをロードする

要求されたページサイズのオブジェクトのリストをロードします。指定されている場合は、与えられたページトークンの後にロードします。

このエンドポイントは、オブジェクトタイプに使用される基礎的なオブジェクト同期技術を活用していることに注意してください。例のレストランが Object Storage V2 によってバックアップされている場合、リクエストの制限はありません。Phonograph によってバックアップされている場合、結果は10,000件が限度です - 10,000件以上の例のレストランが要求されたとき、ObjectsExceededLimit エラーがスローされます。

パラメーター：

pageSize integer（オプション）：最大10,000までの要求するページのサイズ。提供されていない場合、最大10,000の例のレストランをロードします。初期ページの pageSizeは、後続のページに使用されます。
pageToken string（オプション）：提供されている場合、最初に要求されたページの pageSize以下のサイズのページを要求します。

例のクエリ：

Copied!1
2
3
4
5
6
7
8
# client.ontology.objects.ExampleRestaurant.pageでページングを使ってレストランの例を取得します
result = client.ontology.objects.ExampleRestaurant.page(page_size=30, page_token=None)

# 次のページを取得するためのトークン
page_token = result.next_page_token

# 実際のデータ
data = result.data

すべての例示レストランをロードする

すべての例示レストランをロードします。言語によっては、すべての行を含むリストまたはすべての行をループするためのイテレータが結果として得られる可能性があります。

このエンドポイントは、オブジェクトタイプのために使用される基礎となるオブジェクト同期技術を活用していることに注意してください。例示レストランが Object Storage V2 を利用した場合、リクエストの制限はありません。Phonograph を利用した場合、結果は10,000件に制限されます - 10,000件以上の例示レストランが要求された場合、ObjectsExceededLimit エラーがスローされます。

例示クエリ：

Copied!1
2
3
4
5
# クライアントのオントロジーからExampleRestaurantのオブジェクトをイテレート（反復処理）します。
objects_iterator = client.ontology.objects.ExampleRestaurant.iterate()

# イテレータからリストを作成します。
objects = list(objects_iterator)

順序付き結果の読み込み

特定のプロパティに対するソート方向を指定して、Example Restaurants の順序付きリストを読み込みます。API 経由で呼び出す場合、ソート基準は fields 配列を通じて指定されます。SDK 経由で呼び出す場合、複数の orderBy コールをチェーン化できます。文字列のソート順序は大文字と小文字を区別するため、数字は大文字の前、大文字は小文字の前に来ます。たとえば、Cat は bat の前に来ます。

パラメーター：

フィールド string：ソートしたいプロパティ。SDK を使用する場合、これは sortBy インターフェースを通じて提供されます。
方向 asc | desc：昇順または降順のソートを行いたい方向。SDK を使用する場合、これは sortBy インターフェースの asc() と desc() 関数を通じて提供されます。

例のクエリ：

フィルター処理する

フィルター処理することができるタイプは、指定されたオブジェクトタイプのプロパティのタイプによります。これらのフィルターは、より複雑なフィルターを構築するためにブール式を通じて組み合わせることもできます。

このエンドポイントは、オブジェクトタイプのために使用される基礎となるオブジェクト同期技術を活用していることに注意してください。もしExample RestaurantがObject Storage V2によってバックアップされている場合、リクエストの制限はありません。もしPhonographによってバックアップされている場合、結果は10,000件に制限されます – 10,000件以上のExample Restaurantsが要求された場合、ObjectsExceededLimit エラーが投げられます。

パラメーター:

where SearchQuery（オプション）: 特定のプロパティに対してフィルター処理する。可能な操作はプロパティのタイプによります。
orderBy OrderByQuery（オプション）: 特定のプロパティに基づいて結果を順序付ける。SDKを使用している場合、.where コールに orderBy コールをチェインさせて同じ結果を得ることができます。
pageSize integer（オプション）: 最大10,000までのページのサイズをリクエストする。提供されていない場合、最大10,000のExample Restaurantsをロードします。初期ページの pageSize は後続のページで使用されます。SDKを使用している場合、.where コールに .page メソッドをチェインさせます。
pageToken string（オプション）: 提供されている場合、最初にリクエストされたページの pageSize 以下のサイズのページをリクエストします。SDKを使用している場合、.where コールに .page メソッドをチェインさせます。

例のクエリ:

検索フィルターの種類 (`SearchQuery`)

始まり文字列

String プロパティにのみ適用されます。指定された文字列で始まるレストランの例を検索します（大文字と小文字を区別しない）。

パラメーター：

フィールド string：使用するプロパティの名前（例：restaurantName）。
値 string：レストラン名に対してプレフィックスマッチングを使用する値。たとえば、"foo"は "foobar"とマッチしますが、"barfoo"とはマッチしません。

例のクエリ：

任意の用語を含む

これは文字列のプロパティにのみ適用されます。提供された値内で任意の順序で空白で区切られた単語のいずれかを含む Example Restaurants の restaurantName を返します（大文字と小文字を区別しない）。

パラメーター:

フィールド string: 使用するプロパティの名前（例: restaurantName）。
値 string: マッチさせる単語のセットを空白で区切ります。たとえば、 "foo bar" は "bar baz" に一致しますが、 "baz qux" には一致しません。
ファジー boolean: 検索クエリで近似的なマッチングを許可します。

例のクエリ:

すべての用語を含む

String プロパティにのみ適用します。指定した値内での空白区切りの単語をすべて（大文字小文字は区別せず）、任意の順序で含む Example Restaurants を返します。

パラメーター:

フィールド string: 使用するプロパティの名前（例：restaurantName）。
値 string: マッチさせる単語のホワイトスペース区切りのセット。たとえば、"foo bar" は "hello foo baz bar" にマッチしますが、"foo qux" にはマッチしません。
ファジー boolean: 検索クエリでの近似マッチングを許可します。

クエリの例:

すべての用語を順序通りに含む

String プロパティにのみ適用します。提供された順序ですべての用語を含む Example Restaurants を返します（大文字と小文字を区別しない）。ただし、それらは隣接していなければなりません。

パラメーター：

field string：使用するプロパティの名前（例：restaurantName）。
value string：一致させる単語のホワイトスペースで区切られたセット。たとえば、"foo bar" は "hello foo bar baz" に一致しますが、"bar foo qux" には一致しません。
fuzzy boolean：検索クエリで近似的な一致を許可します。

例のクエリ：

等しい

これは、Boolean、DateTime、Numeric、およびString プロパティにのみ適用されます。restaurantName が指定された値と等しいExample Restaurantsを検索します。

パラメーター:

フィールド string: 使用するプロパティの名前（例：restaurantName）。
値 string: Restaurant Nameと等しいかチェックする値。

例クエリ:

Null チェック

Array、Boolean、DateTime、Numeric、および String プロパティにのみ適用されます。restaurantName の値が存在するかどうかに基づいて Example Restaurants を検索します。

パラメーター:

field string: 使用するプロパティの名前（例：restaurantName）。
value boolean: Restaurant Name が存在するかどうか。TypeScript SDK の場合、フィールドが null でないことをチェックするために not フィルター処理する必要があることに注意してください。

例のクエリ：

フィルター処理しない

クエリが満たされない場合に、Example Restaurantsを返します。これは他のブール型のフィルター操作とさらに組み合わせることができます。

パラメーター:

value SearchQuery: 反転させる検索クエリ。

例のクエリ:

そしてフィルター処理する

すべてのクエリが満足される場合にExample Restaurantsを返します。これは他のブール型フィルター処理とさらに組み合わせることができます。

パラメーター:

値 SearchQuery[]: and で結合する検索クエリのセット。

例のクエリ:

またはフィルター処理する

指定されたクエリのいずれかが満たされる場合に、Example Restaurantsを返します。これは他のブールフィルター操作とさらに組み合わせることができます。

パラメーター:

value SearchQuery[]: orで結合する検索クエリのセット。

例のクエリ:

集計

Example Restaurants で集計を実行します。

パラメーター:

集計 Aggregation[]（オプション）: 実行する集計関数のセット。SDK を使用すると、集計計算を .where を使ってさらに検索に連鎖させることができます。
groupBy GroupBy[]（オプション）: 集計結果のためのグルーピングセット
where SearchQuery（オプション）: 特定のプロパティに対してフィルター処理する。可能な操作はプロパティのタイプに依存します。

例のクエリ:

{
    // 除外される項目の数
    excludedItems: 0,
    
    // データ配列
    data: [{
        // グループ情報
        group: {
            // レストランの名前
            "restaurantName": "Restaurant Name"
        },
        
        // メトリクス配列
        metrics: [
            {
                // メトリクスの名前
                name: "count",
                
                // メトリクスの値
                value: 100
            }
        ]
    }]
}

集計の種類 (`Aggregation`)

近似的な distinct

restaurantName の異なる値の近似数を計算します。

パラメーター：

フィールド string：使用するプロパティの名前（例：restaurantName）。
name string（オプション）：計算されたカウントのエイリアス。デフォルトでは、これは "distinctCount" です。

例のクエリ：

{
    // 除外されるアイテムの数
    excludedItems: 0,
    // データセット
    data: [{
        // グループ
        group: {},
        // メトリクス（計測データ）
        metrics: [
            {
                // メトリクスの名前
                name: "distinctCount",
                // メトリクスの値
                value: 100
            }
        ]
    }]
}

カウント

Example Restaurants の合計カウントを計算します。

パラメーター：

name string（オプション）：計算されたカウントのエイリアス。デフォルトでは、これは count です。

例のクエリ：

Copied!1
2
3
4
# "client.ontology.objects.ExampleRestaurant" によって、例のレストランオブジェクトを取得します。
numExampleRestaurant = client.ontology.objects.ExampleRestaurant
    .count()  # .count() を使用して、取得したレストランオブジェクトの数を数えます。
    .compute()  # .compute() を使用して、計算を実行します。

{
    // 除外されたアイテムの数
    excludedItems: 0,
    // データの配列
    data: [{
        // グループ情報
        group: {},
        // メトリクスの配列
        metrics: [
            {
                // メトリクスの名前
                name: "count",
                // メトリクスの値
                value: 100
            }
        ]
    }]
}

数値集計

数値プロパティにのみ適用されます。たとえば、Example Restaurants の数値プロパティの最大値、最小値、合計、または平均を計算します。

パラメーター：

field string：使用するプロパティの名前（例：numberOfReviews）。
name string（オプション）：計算された値のエイリアス。デフォルトでは、「avg」となります。

集計タイプ：

平均：avg()
最大値：max()
最小値：min()
合計：sum()

例のクエリ：

{
    excludedItems: 0,  // 除外されたアイテムの数：0
    data: [{          // データの配列
        group: {},    // グループ（空のオブジェクト）
        metrics: [    // メトリクスの配列
            {
                name: "avg", // メトリクスの名前："avg"
                value: 100   // メトリクスの値：100
            }
        ]
    }]
}

グループ化のタイプ (`GroupBy`)

正確なグルーピング

Example Restaurants を restaurantName の正確な値によってグループ化します。

パラメーター:

field string: 使用するプロパティの名前（例：restaurantName）。
maxGroupCount integer (任意): 作成する restaurantName のグループ化の最大数。

クエリの例:

Python オントロジー SDK

単一のレストランのロード

例のレストランのページをロードする

すべての例示レストランをロードする

順序付き結果の読み込み

フィルター処理する

検索フィルターの種類 (SearchQuery)

始まり文字列

任意の用語を含む

すべての用語を含む

すべての用語を順序通りに含む

等しい

Null チェック

フィルター処理しない

そしてフィルター処理する

またはフィルター処理する

集計

集計の種類 (Aggregation)

近似的な distinct

カウント

数値集計

グループ化のタイプ (GroupBy)

正確なグルーピング

検索フィルターの種類 (`SearchQuery`)

集計の種類 (`Aggregation`)

グループ化のタイプ (`GroupBy`)