Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .env
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
PERIGON_API_KEY="1354fd4c-91dc-43fc-86d5-fcd114bfdd09"
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,3 @@ target/

#Ipython Notebook
.ipynb_checkpoints

.env
13 changes: 4 additions & 9 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
README.md
perigon/__init__.py
perigon/api/__init__.py
perigon/api/supplemental_endpoints_api.py
perigon/api/v1_api.py
perigon/api_client.py
perigon/api_response.py
Expand All @@ -13,10 +12,6 @@ perigon/models/article.py
perigon/models/article_search_filter.py
perigon/models/article_search_params.py
perigon/models/articles_vector_search_result.py
perigon/models/auth_exception.py
perigon/models/auth_exception_cause.py
perigon/models/auth_exception_cause_stack_trace_inner.py
perigon/models/auth_exception_suppressed_inner.py
perigon/models/category_holder.py
perigon/models/category_with_score_holder.py
perigon/models/company.py
Expand All @@ -26,11 +21,10 @@ perigon/models/company_search_result.py
perigon/models/coordinate.py
perigon/models/coordinate_filter.py
perigon/models/entity_holder.py
perigon/models/error_response.py
perigon/models/event_type_holder.py
perigon/models/id_name_holder.py
perigon/models/illegal_parameter_exception.py
perigon/models/image_holder.py
perigon/models/internal_error_exception.py
perigon/models/journalist.py
perigon/models/journalist_search_result.py
perigon/models/key_point.py
Expand All @@ -40,7 +34,6 @@ perigon/models/location_count.py
perigon/models/location_holder.py
perigon/models/name_count.py
perigon/models/news_cluster.py
perigon/models/not_found_exception.py
perigon/models/people_search_result.py
perigon/models/person.py
perigon/models/person_count.py
Expand All @@ -58,11 +51,13 @@ perigon/models/source_holder.py
perigon/models/source_location.py
perigon/models/source_search_result.py
perigon/models/source_top_stat_holder.py
perigon/models/stat_result.py
perigon/models/story_history_record.py
perigon/models/story_history_result.py
perigon/models/story_search_result.py
perigon/models/summary_body.py
perigon/models/summary_search_result.py
perigon/models/symbol_holder.py
perigon/models/too_many_requests_exception.py
perigon/models/topic_dto.py
perigon/models/topic_holder.py
perigon/models/topic_labels.py
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ articles, journalist = asyncio.run(fetch_data())

### Articles – search and filter news (`/v1/all`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=11>
**Docs →** [https://docs.perigon.io/docs/overview](https://docs.perigon.io/docs/overview)

```python
# Simple query
Expand All @@ -127,15 +127,15 @@ articles = api.search_articles(source=["nytimes.com"])

### Companies – fetch structured company data (`/v1/companies`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=2>
**Docs →** [https://docs.perigon.io/docs/company-data](https://docs.perigon.io/docs/company-data)

```python
results = api.search_companies(name="Apple", size=5)
```

### Journalists – search and detail look‑up (`/v1/journalists`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=2>
**Docs →** [https://docs.perigon.io/docs/journalist-data](https://docs.perigon.io/docs/journalist-data)

```python
# Search for journalists
Expand All @@ -147,15 +147,15 @@ journalist = api.get_journalist_by_id(id=results.journalists[0].id)

### Stories – discover related article clusters (`/v1/stories`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=7>
**Docs →** [https://docs.perigon.io/docs/stories-overview](https://docs.perigon.io/docs/stories-overview)

```python
stories = api.search_stories(q="climate change", size=5)
```

### Vector search – semantic retrieval (`/v1/vector`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=10>
**Docs →** [https://docs.perigon.io/docs/vector-endpoint](https://docs.perigon.io/docs/vector-endpoint)

```python
from perigon.models.article_search_params import ArticleSearchParams
Expand All @@ -170,7 +170,7 @@ results = api.vector_search_articles(

### Summarizer – generate an instant summary (`/v1/summarizer`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=8>
**Docs →** [https://docs.perigon.io/docs/search-summarizer](https://docs.perigon.io/docs/search-summarizer)

```python
from perigon.models.summary_body import SummaryBody
Expand All @@ -186,15 +186,15 @@ print(summary)

### Topics – explore taxonomy (`/v1/topics`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=9>
**Docs →** [https://docs.perigon.io/docs/topics](https://docs.perigon.io/docs/topics)

```python
topics = api.search_topics(size=10)
```

### Wikipedia – search and filter pages (`/v1/wikipedia`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=13>
**Docs →** [https://docs.perigon.io/docs/wikipedia](https://docs.perigon.io/docs/wikipedia)

```python
# Search Wikipedia pages
Expand All @@ -213,7 +213,7 @@ wikipedia_result = api.search_wikipedia(

### Wikipedia vector search – semantic retrieval (`/v1/vector/wikipedia`)<br>

**Docs →** <https://dev.perigon.io/reference?endpoint=12>
**Docs →** [https://docs.perigon.io/docs/vector-wikipedia](https://docs.perigon.io/docs/vector-wikipedia)

```python
from perigon.models.wikipedia_search_params import WikipediaSearchParams
Expand Down
15 changes: 4 additions & 11 deletions perigon/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
__version__ = "1.0.0"

# import apis into sdk package
from perigon.api.supplemental_endpoints_api import SupplementalEndpointsApi
from perigon.api.v1_api import V1Api
from perigon.api_client import ApiClient

Expand All @@ -39,12 +38,6 @@
from perigon.models.article_search_filter import ArticleSearchFilter
from perigon.models.article_search_params import ArticleSearchParams
from perigon.models.articles_vector_search_result import ArticlesVectorSearchResult
from perigon.models.auth_exception import AuthException
from perigon.models.auth_exception_cause import AuthExceptionCause
from perigon.models.auth_exception_cause_stack_trace_inner import (
AuthExceptionCauseStackTraceInner,
)
from perigon.models.auth_exception_suppressed_inner import AuthExceptionSuppressedInner
from perigon.models.category_holder import CategoryHolder
from perigon.models.category_with_score_holder import CategoryWithScoreHolder
from perigon.models.company import Company
Expand All @@ -54,11 +47,10 @@
from perigon.models.coordinate import Coordinate
from perigon.models.coordinate_filter import CoordinateFilter
from perigon.models.entity_holder import EntityHolder
from perigon.models.error_response import ErrorResponse
from perigon.models.event_type_holder import EventTypeHolder
from perigon.models.id_name_holder import IdNameHolder
from perigon.models.illegal_parameter_exception import IllegalParameterException
from perigon.models.image_holder import ImageHolder
from perigon.models.internal_error_exception import InternalErrorException
from perigon.models.journalist import Journalist
from perigon.models.journalist_search_result import JournalistSearchResult
from perigon.models.key_point import KeyPoint
Expand All @@ -68,7 +60,6 @@
from perigon.models.location_holder import LocationHolder
from perigon.models.name_count import NameCount
from perigon.models.news_cluster import NewsCluster
from perigon.models.not_found_exception import NotFoundException
from perigon.models.people_search_result import PeopleSearchResult
from perigon.models.person import Person
from perigon.models.person_count import PersonCount
Expand All @@ -86,11 +77,13 @@
from perigon.models.source_location import SourceLocation
from perigon.models.source_search_result import SourceSearchResult
from perigon.models.source_top_stat_holder import SourceTopStatHolder
from perigon.models.stat_result import StatResult
from perigon.models.story_history_record import StoryHistoryRecord
from perigon.models.story_history_result import StoryHistoryResult
from perigon.models.story_search_result import StorySearchResult
from perigon.models.summary_body import SummaryBody
from perigon.models.summary_search_result import SummarySearchResult
from perigon.models.symbol_holder import SymbolHolder
from perigon.models.too_many_requests_exception import TooManyRequestsException
from perigon.models.topic_dto import TopicDto
from perigon.models.topic_holder import TopicHolder
from perigon.models.topic_labels import TopicLabels
Expand Down
1 change: 0 additions & 1 deletion perigon/api/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# flake8: noqa

# import apis into api package
from perigon.api.supplemental_endpoints_api import SupplementalEndpointsApi
from perigon.api.v1_api import V1Api
Loading