directSearch
ContentSpace を根拠付きで検索する
POST/v1.0/search
Schema preview / 現在は一般提供されていません
1 operationはOpenAPIでschema-onlyとして公開されています。このReferenceからAPI requestは送信できません。
Authentication
すべてのrequestはX-Api-Key headerを使用します。schema-onlyのため、このページにcredential入力やlive requestはありません。
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| X-Request-Id | header | string | 要求相関 ID。省略時は Gateway が生成する。 |
| Idempotency-Keyrequired | header | string | 同一主体、version、endpoint、security workspace 内で検索とArtifact保存を収束させる key。visible ASCII、最大255 byte。 |
Request body
v1PublicLifecycleServiceDirectSearchRequest
PublicLifecycleServiceDirectSearchRequest はContentSpace内のDirect Search条件を表す。
| Field | Type | Description |
|---|---|---|
| contentSpaceIdrequired | string | content_space_id は検索境界となる`space_` + ULID形式のContentSpace IDである。 |
| queryTextrequired | string | query_text は1文字以上2000文字以下の自然言語queryである。 |
| maxResults | integer | max_results は1以上10以下で、0の場合はserver既定値10を使用する。 |
| assetIds | array | asset_ids は対象を限定する任意filterであり、空の場合はContentSpace全体、最大50件である。 |
Responses and errors
200根拠付きMomentを返した。該当なしはresultsが空の成功responseである。
v1PublicLifecycleServiceDirectSearchResponse
PublicLifecycleServiceDirectSearchResponse は根拠付きMomentと検索結果Artifactを返す。
| Field | Type | Description |
|---|---|---|
| results | array | results は関連度順の0件以上10件以下の根拠付きMomentである。 |
| searchArtifactId | string | search_artifact_id は検索候補を保存した`art_` + ULID形式のArtifact IDである。 |
| metrics | v1PublicDirectSearchMetrics | metrics は検索処理のlatencyと一次候補件数である。 |
400公開requestの形式、必須項目、または範囲が不正である。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
401API keyを検証できない。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
404ContentSpaceが存在しない、またはsecurity workspaceから参照できない。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
409検索可能なactive routeがなく、完全な結果を返せない。部分結果は返さない。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
500予期しない内部失敗が発生した。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |
503検索provider、credential provider、または検索資源が一時的に利用できない。
v1PublicError
PublicError は provider や security workspace の内部情報を含まない公開 error envelope である。
| Field | Type | Description |
|---|---|---|
| code | string | code は公開 API で安定した machine-readable error code である。 |
| message | string | message は利用者向けの説明であり、resource の存在と workspace 外参照を区別しない。 |
| requestId | string | request_id は response header の X-Request-Id と同じ要求相関 ID である。 |
| docsUrl | string | docs_url は関連する公開文書が存在する場合だけ設定する URL である。 |
| quotaExceeded | v1PublicQuotaExceeded | quota_exceeded は quota 超過による拒否時だけ設定する機械可読な詳細である。 |