Basic Search
Search for concepts by text:Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
query | string | required | Search query string |
vocabulary_ids | list[str] | None | Filter by vocabulary IDs |
domain_ids | list[str] | None | Filter by domain IDs |
concept_class_ids | list[str] | None | Filter by concept class IDs |
standard_concept | string | None | Filter by standard concept (“S”, “C”, or None) |
include_synonyms | bool | False | Search in synonyms |
include_invalid | bool | True | Include invalid concepts |
min_score | float | None | Minimum relevance score (0.0-1.0) |
exact_match | bool | False | Require exact match |
page | int | 1 | Page number (1-based) |
page_size | int | 20 | Results per page |
sort_by | string | None | Sort field |
sort_order | string | None | Sort order (“asc” or “desc”) |
Filter by Vocabulary
Restrict search to specific vocabularies:Filter by Domain
Search within specific domains:Filter by Concept Class
Search for specific concept classes:Standard Concepts Only
Filter to standard concepts:Search with Synonyms
Include concept synonyms in search:Combined Filters
Autocomplete
Get suggestions as the user types:Pagination
Manual Pagination
Auto-Pagination Iterator
Iterate through all results automatically:Advanced Search
Use advanced search with additional filtering options and facets:Advanced Search Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
query | string | required | Search query string |
vocabulary_ids | list[str] | None | Filter by vocabulary IDs |
domain_ids | list[str] | None | Filter by domain IDs |
concept_class_ids | list[str] | None | Filter by concept class IDs |
standard_concepts_only | bool | False | Only return standard concepts |
include_invalid | bool | True | Include invalid concepts |
relationship_filters | list[dict] | None | Relationship-based filters |
page | int | 1 | Page number (1-based) |
page_size | int | 20 | Results per page |
Relationship Filters
Apply relationship-based filtering:Semantic Search
Search for concepts using natural language with neural embeddings. Semantic search understands meaning, not just keywords.Semantic Search Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
query | string | required | Natural language search query |
vocabulary_ids | list[str] | None | Filter by vocabulary IDs |
domain_ids | list[str] | None | Filter by domain IDs |
standard_concept | ”S” | “C” | None | Filter by standard concept flag |
concept_class_id | string | None | Filter by concept class |
threshold | float | 0.5 | Minimum similarity (0.0-1.0) |
page | int | 1 | Page number |
page_size | int | 20 | Results per page (max 100) |
Semantic Search Iterator
Iterate through all semantic search results with automatic pagination:Async Semantic Search
Find Similar Concepts
Find concepts similar to a reference concept or query. Provide exactly one of:concept_id, concept_name, or query.
Similar Concepts Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
concept_id | int | None | Source concept ID |
concept_name | string | None | Source concept name |
query | string | None | Natural language query |
algorithm | string | ”hybrid" | "semantic”, “lexical”, or “hybrid” |
similarity_threshold | float | 0.7 | Minimum similarity (0.0-1.0) |
page_size | int | 20 | Max results (max 1000) |
vocabulary_ids | list[str] | None | Filter by vocabulary |
domain_ids | list[str] | None | Filter by domain |
standard_concept | string | None | ”S”, “C”, or “N” |
include_invalid | bool | None | Include invalid/deprecated concepts |
include_scores | bool | None | Include detailed scores |
include_explanations | bool | None | Include similarity explanations |
Algorithm Comparison
| Algorithm | Best For | Speed |
|---|---|---|
semantic | Meaning-based similarity | Slower |
lexical | Text/string similarity | Faster |
hybrid | Balanced approach | Medium |