Skip to content

Commit d1e927d

Browse files
authored
Add docs on select and sample
1 parent 61ca949 commit d1e927d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The following features of OpenAlex are currently supported by PyAlex:
1919
- [x] Search entities
2020
- [x] Group entities
2121
- [x] Search filters
22+
- [x] Select fields
23+
- [x] Sample
2224
- [x] Pagination
2325
- [ ] [Autocomplete endpoint](https://docs.openalex.org/how-to-use-the-api/get-lists-of-entities/autocomplete-entities)
2426
- [x] N-grams
@@ -193,6 +195,22 @@ OpenAlex reference: [Sort entity lists](https://docs.openalex.org/api-entities/w
193195
Works().sort(cited_by_count="desc").get()
194196
```
195197

198+
#### Select
199+
200+
OpenAlex reference: [Select fields](https://docs.openalex.org/how-to-use-the-api/get-lists-of-entities/select-fields).
201+
202+
```python
203+
Works().filter(publication_year=2020, is_oa=True).select(["id", "doi"]).get()
204+
```
205+
206+
#### Sample
207+
208+
OpenAlex reference: [Sample entity lists](https://docs.openalex.org/how-to-use-the-api/get-lists-of-entities/sample-entity-lists).
209+
210+
```python
211+
Works().sample(100, seed=535).get()
212+
```
213+
196214
#### Logical expressions
197215

198216
OpenAlex reference: [Logical expressions](https://docs.openalex.org/how-to-use-the-api/get-lists-of-entities/filter-entity-lists#logical-expressions)

0 commit comments

Comments
 (0)