Skip to content
This repository was archived by the owner on Mar 7, 2025. It is now read-only.

Commit 1d85d2b

Browse files
Tomas2DTomas2D
authored
docs: update changelog and docs order (#303)
1 parent cc38ecb commit 1d85d2b

File tree

2 files changed

+126
-0
lines changed

2 files changed

+126
-0
lines changed

‎documentation/source/changelog.rst‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,131 @@
11
Changelog
22
=========
33

4+
5+
v2.1.0 (2024-01-30)
6+
-------------------
7+
8+
.. admonition:: Schema Import (deprecation warning)
9+
:class: warning
10+
11+
Schemas are now exported from genai.schema (the old way of importing remains to work, but you will receive a warning)
12+
13+
14+
🚀 Features / Enhancements
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
- feat: refactor schemas for better user experience `#(294) <https://github.com/IBM/ibm-generative-ai/pull/294>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
17+
- feat: add truncate_input_tokens parameter for embeddings `#(280) <https://github.com/IBM/ibm-generative-ai/pull/280>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
18+
- feat: migrate to langchain_core `#(261) <https://github.com/IBM/ibm-generative-ai/pull/261>`_ [`@David-Kristek <https://github.com/David-Kristek>`_]
19+
- feat: adjust tests and pipeline to ensure 3.12 compatibility `#(259) <https://github.com/IBM/ibm-generative-ai/pull/259>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
20+
- feat: retrieve service actions metadata `#(260) <https://github.com/IBM/ibm-generative-ai/pull/260>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
21+
- feat(example): add chromadb embedding function `#(270) <https://github.com/IBM/ibm-generative-ai/pull/270>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
22+
- feat(langchain): correctly handles prompt_id and model_id `#(293) <https://github.com/IBM/ibm-generative-ai/pull/293>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
23+
- feat(system-prompts): init module `#(292) <https://github.com/IBM/ibm-generative-ai/pull/292>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
24+
- feat(langchain): add embeddings support `#(289) <https://github.com/IBM/ibm-generative-ai/pull/289>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
25+
- feat(examples): add example of langchain agent with tools `#(268) <https://github.com/IBM/ibm-generative-ai/pull/268>`_ [`@David-Kristek <https://github.com/David-Kristek>`_]
26+
- feat(langchain): update core and related dependencies `#(282) <https://github.com/IBM/ibm-generative-ai/pull/282>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
27+
28+
🐛 Bug Fixes
29+
^^^^^^^^^^^^^
30+
- fix: rewrite test casettes due to vcrpy update `#(290) <https://github.com/IBM/ibm-generative-ai/pull/290>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
31+
- fix: update vcrpy to released version `#(284) <https://github.com/IBM/ibm-generative-ai/pull/284>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
32+
- fix: external limiter implementation `#(274) <https://github.com/IBM/ibm-generative-ai/pull/274>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
33+
- fix: include overhead in payload size calculation when batching `#(266) <https://github.com/IBM/ibm-generative-ai/pull/266>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
34+
- fix: reduce maximum payload size [`@jezekra1 <https://github.com/jezekra1>`_]
35+
- fix: schema action metadata inheritance `#(262) <https://github.com/IBM/ibm-generative-ai/pull/262>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
36+
- fix(docs): redirects `#(298) <https://github.com/IBM/ibm-generative-ai/pull/298>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
37+
- fix(langchain): templates and models `#(293) <https://github.com/IBM/ibm-generative-ai/pull/293>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
38+
39+
📖 Docs
40+
^^^^^^^
41+
- docs: update links in README [`@Tomas2D <https://github.com/Tomas2D>`_]
42+
- docs: update link to the migration guide [`@Tomas2D <https://github.com/Tomas2D>`_]
43+
- docs: init documentation versioning `#(296) <https://github.com/IBM/ibm-generative-ai/pull/296>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
44+
- docs: add installation note for extensions `#(291) <https://github.com/IBM/ibm-generative-ai/pull/291>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
45+
- docs: update prompt usage example `#(275) <https://github.com/IBM/ibm-generative-ai/pull/275>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
46+
- docs: update migration guide, examples, deploy `#(271) <https://github.com/IBM/ibm-generative-ai/pull/271>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
47+
- docs: update migration guide `#(269) <https://github.com/IBM/ibm-generative-ai/pull/269>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
48+
- docs: update README [`@Tomas2D <https://github.com/Tomas2D>`_]
49+
- docs: update faq / credentials / migration guide `#(263) <https://github.com/IBM/ibm-generative-ai/pull/263>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
50+
- docs: add changelog `#(257) <https://github.com/IBM/ibm-generative-ai/pull/257>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
51+
- docs: improve examples `#(258) <https://github.com/IBM/ibm-generative-ai/pull/258>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
52+
53+
⚙️ Other
54+
^^^^^^^^
55+
- build: add langchain to dev dependencies [`@Tomas2D <https://github.com/Tomas2D>`_]
56+
- refactor: remove list comprehensions to preserve type-hints `#(301) <https://github.com/IBM/ibm-generative-ai/pull/301>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
57+
- ci: update git checkout for documentation build [`@Tomas2D <https://github.com/Tomas2D>`_]
58+
- ci: update docs build script [`@Tomas2D <https://github.com/Tomas2D>`_]
59+
- ci: set CODEOWNERS `#(267) <https://github.com/IBM/ibm-generative-ai/pull/267>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
60+
- build: remove unused dependencies and update versions `#(264) <https://github.com/IBM/ibm-generative-ai/pull/264>`_ [`@Tomas2D <https://github.com/Tomas2D>`_]
61+
- ci: check if all tests have markers `#(265) <https://github.com/IBM/ibm-generative-ai/pull/265>`_ [`@jezekra1 <https://github.com/jezekra1>`_]
62+
63+
**Full Changelog**: `v2.0.0...v2.1.0 <https://github.com/IBM/ibm-generative-ai/compare/v2.0.0...v2.1.0>`_
64+
65+
66+
🔗 API Endpoint Versions
67+
^^^^^^^^^^^^^^^^^^^^^^^^
68+
69+
.. collapse:: API Endpoint Versions
70+
71+
======== ================================== ======================
72+
Method Path Version (YYYY-MM-DD)
73+
======== ================================== ======================
74+
GET /v2/api_key 2023-11-22
75+
POST /v2/api_key/regenerate 2023-11-22
76+
GET /v2/files 2023-12-15
77+
POST /v2/files 2023-12-15
78+
DELETE /v2/files/{id} 2023-11-22
79+
GET /v2/files/{id} 2023-12-15
80+
GET /v2/files/{id}/content 2023-11-22
81+
GET /v2/models 2023-11-22
82+
GET /v2/models/{id} 2024-01-30
83+
GET /v2/prompts 2024-01-10
84+
POST /v2/prompts 2024-01-10
85+
DELETE /v2/prompts/{id} 2023-11-22
86+
GET /v2/prompts/{id} 2024-01-10
87+
PATCH /v2/prompts/{id} 2024-01-10
88+
PUT /v2/prompts/{id} 2024-01-10
89+
GET /v2/requests 2023-11-22
90+
DELETE /v2/requests/chat/{conversationId} 2023-11-22
91+
GET /v2/requests/chat/{conversationId} 2023-11-22
92+
DELETE /v2/requests/{id} 2023-11-22
93+
GET /v2/system_prompts 2023-11-22
94+
POST /v2/system_prompts 2023-11-22
95+
DELETE /v2/system_prompts/{id} 2023-11-22
96+
GET /v2/system_prompts/{id} 2023-11-22
97+
PUT /v2/system_prompts/{id} 2023-11-22
98+
GET /v2/tasks 2023-11-22
99+
POST /v2/text/chat 2024-01-10
100+
POST /v2/text/chat/output 2024-01-10
101+
POST /v2/text/chat_stream 2024-01-10
102+
POST /v2/text/embeddings 2023-11-22
103+
GET /v2/text/embeddings/limits 2023-11-22
104+
GET /v2/text/extraction/limits 2023-11-22
105+
POST /v2/text/generation 2024-01-10
106+
POST /v2/text/generation/comparison 2023-11-22
107+
GET /v2/text/generation/limits 2023-11-22
108+
POST /v2/text/generation/output 2023-11-22
109+
GET /v2/text/generation/{id}/feedback 2023-11-22
110+
POST /v2/text/generation/{id}/feedback 2023-11-22
111+
PUT /v2/text/generation/{id}/feedback 2023-11-22
112+
POST /v2/text/generation_stream 2024-01-10
113+
POST /v2/text/moderations 2023-11-22
114+
POST /v2/text/tokenization 2024-01-10
115+
GET /v2/tunes 2023-11-22
116+
POST /v2/tunes 2023-11-22
117+
POST /v2/tunes/import 2023-11-22
118+
DELETE /v2/tunes/{id} 2023-11-22
119+
GET /v2/tunes/{id} 2023-11-22
120+
PATCH /v2/tunes/{id} 2023-11-22
121+
GET /v2/tunes/{id}/content/{type} 2023-12-15
122+
GET /v2/tuning_types 2024-01-30
123+
DELETE /v2/user 2023-11-22
124+
GET /v2/user 2023-11-22
125+
PATCH /v2/user 2023-11-22
126+
POST /v2/user 2023-11-22
127+
======== ================================== ======================
128+
4129
v2.0.0 (2024-01-15)
5130
-------------------
6131

‎scripts/docs_examples_generator/config.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ class GeneratorConfig(BaseModel):
2222
"examples.model",
2323
"examples.tune",
2424
"examples.prompt",
25+
"examples.system_prompt",
2526
"examples.file",
2627
"examples.user",
2728
"examples.request",

0 commit comments

Comments
 (0)