CLI を使い始める
sources
@orchestor-inc/cli のコマンドリファレンスです。
コマンド一覧
orc sources gaps list— List locally derived source gapsorc sources domains list— List source domainsorc sources domains get— Get source domain detailorc sources urls list— List source URLsorc sources urls get— Get source URL detailorc sources citations list— List source citation aggregates
orc sources gaps list
List locally derived source gaps
構文
orc sources gaps list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--view | string | いいえ | enum: domain|host|url |
--min-competitors | number | いいえ | Minimum distinct configured competitors found in an answer. |
--start-date | string | いいえ | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | いいえ | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--search | string | いいえ | Case-insensitive source hostname, URL, or title search. |
--filter[platform] | string | いいえ | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | いいえ | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | いいえ | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | いいえ | Comma-separated prompt tag names for the answer cohort. |
--filter[mentioned-brand-id] | string | いいえ | Comma-separated competitor Brand IDs that must be mentioned in qualifying answers. |
--filter[country] | string | いいえ | Comma-separated ISO 3166-1 alpha-2 country codes for qualifying prompts. |
--mentioned-brand-operator | string | いいえ | Whether any or all selected mentioned Brand IDs must occur in a qualifying answer.; enum: or|and |
--filter[domain-classification] | string | いいえ | Comma-separated SourceDomainClassification values. |
--filter[url-classification] | string | いいえ | Comma-separated SourceUrlClassification values. |
--sort | string | いいえ | Field used to order the derived gap rows.; enum: source|competitor_count|retrieval_count|retrieved_percentage|retrieval_rate|citation_rate|gap_score |
--order | string | いいえ | Sort direction.; enum: asc|desc |
--page | number | いいえ | value |
--limit | number | いいえ | Maximum number of items to return |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc source list-gaps
ヘルプ
orc sources gaps list --helporc sources domains list
List source domains
構文
orc sources domains list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--project | string | いいえ | Optional project filter for web callers. |
--view | string | いいえ | Rollup axis for source evidence rows; domain uses registrable domains and host uses normalized hostnames.; enum: domain|host |
--start-date | string | いいえ | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | いいえ | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--cohort | string | いいえ | Source mover view over the union of retrieval evidence and citation events; top includes either current retrievals or citations, while new, trending, and losing use retrieval observations only. Cohorts are overlapping views, not exclusive buckets.; enum: top|new|trending|losing |
--filter[platform] | string | いいえ | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | いいえ | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | いいえ | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | いいえ | Comma-separated prompt tag names for the answer cohort. |
--filter[classification] | string | いいえ | Comma-separated SourceDomainClassification values. |
--sort | string | いいえ | enum: hostname|classification|retrieval_count|retrieval_change|retrieval_rate|retrieval_frequency|citation_count|citation_rate|url_count|share_of_voice|first_seen_at|last_seen_at |
--order | string | いいえ | enum: asc|desc |
--page | number | いいえ | value |
--limit | number | いいえ | Maximum number of items to return |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc source list-domains
ヘルプ
orc sources domains list --helporc sources domains get
Get source domain detail
構文
orc sources domains get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Source-domain hostname from the host view of the list endpoint. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc source get-domain
ヘルプ
orc sources domains get --helporc sources urls list
List source URLs
構文
orc sources urls list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--project | string | いいえ | value |
--start-date | string | いいえ | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | いいえ | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--cohort | string | いいえ | Source mover view over the union of retrieval evidence and citation events; top includes either current retrievals or citations, while new, trending, and losing use retrieval observations only. Cohorts are overlapping views, not exclusive buckets.; enum: top|new|trending|losing |
--filter[platform] | string | いいえ | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | いいえ | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | いいえ | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | いいえ | Comma-separated prompt tag names for the answer cohort. |
--filter[classification] | string | いいえ | Comma-separated SourceUrlClassification values. |
--sort | string | いいえ | enum: url|hostname|retrieval_count|retrieval_change|citation_count|share_of_voice|first_seen_at|last_seen_at |
--order | string | いいえ | enum: asc|desc |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc source list-urls
ヘルプ
orc sources urls list --helporc sources urls get
Get source URL detail
構文
orc sources urls get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | URL-encoded source URL from the list endpoint. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc source get-url
ヘルプ
orc sources urls get --helporc sources citations list
List source citation aggregates
構文
orc sources citations list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--project | string | いいえ | value |
--start-date | string | いいえ | Inclusive lower bound as a UTC calendar date (YYYY-MM-DD). |
--end-date | string | いいえ | Inclusive upper bound as a UTC calendar date (YYYY-MM-DD). |
--group-by | string | はい | Comma-separated SourceCitationGroupBy values. |
--bucket-width | string | いいえ | Required when group_by includes date.; enum: day|week|month |
--classification-scope | string | いいえ | Selects whether group_by=classification returns domain classifications or URL classifications.; enum: domain|url |
--filter[hostname] | string | いいえ | Comma-separated hostnames. |
--filter[domain] | string | いいえ | Comma-separated registrable domains; subdomains are normalized to their registrable domain. |
--filter[url] | string | いいえ | Comma-separated URLs. |
--filter[classification] | string | いいえ | Comma-separated classification values matching classification_scope. |
--filter[platform] | string | いいえ | Comma-separated model platform values (for example, openai or anthropic). |
--filter[topic-id] | string | いいえ | Comma-separated topic IDs for the answer cohort. |
--filter[brand-id] | string | いいえ | Comma-separated owned Brand IDs for the answer cohort. |
--filter[tag] | string | いいえ | Comma-separated prompt tag names for the answer cohort. |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc source list-citations
ヘルプ
orc sources citations list --help