Skip to content

Commit 91598ac

Browse files
docs(api): updates to API spec
1 parent ba97e8f commit 91598ac

26 files changed

Lines changed: 211 additions & 176 deletions

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 30
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-d15316b8a3a086ae9ec8eea0d436b0885262df9bcf23b9587ad059e50357c220.yml
3-
openapi_spec_hash: 4f81a4f4840438f80eff345e76ead962
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-a8e20e751972f7b8c948a833764b02d0835b380189eaf7393d63eb2250dbd598.yml
3+
openapi_spec_hash: 6f27335468bc5bf01fbcd1454330fb07
44
config_hash: ee2e5a914fd298a6f4c740f5ce187f87

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ client = Writer()
254254

255255
chat_completion = client.chat.chat(
256256
messages=[{"role": "user"}],
257-
model="model",
257+
model="palmyra-x-004",
258258
stream_options={"include_usage": True},
259259
)
260260
print(chat_completion.stream_options)

src/writerai/resources/applications/applications.py

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ def retrieve(
8989
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
9090
) -> ApplicationRetrieveResponse:
9191
"""
92-
Retrieves detailed information for a specific no-code application, including its
93-
configuration and current status.
92+
Retrieves detailed information for a specific no-code agent (formerly called
93+
no-code applications), including its configuration and current status.
9494
9595
Args:
9696
extra_headers: Send extra headers
@@ -127,8 +127,8 @@ def list(
127127
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
128128
) -> SyncCursorPage[ApplicationListResponse]:
129129
"""
130-
Retrieves a paginated list of no-code applications with optional filtering and
131-
sorting capabilities.
130+
Retrieves a paginated list of no-code agents (formerly called no-code
131+
applications) with optional filtering and sorting capabilities.
132132
133133
Args:
134134
after: Return results after this application ID for pagination.
@@ -186,7 +186,8 @@ def generate_content(
186186
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
187187
) -> ApplicationGenerateContentResponse:
188188
"""
189-
Generate content from an existing no-code application with inputs.
189+
Generate content from an existing no-code agent (formerly called no-code
190+
applications) with inputs.
190191
191192
Args:
192193
stream: Indicates whether the response should be streamed. Currently only supported for
@@ -217,7 +218,8 @@ def generate_content(
217218
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
218219
) -> Stream[ApplicationGenerateContentChunk]:
219220
"""
220-
Generate content from an existing no-code application with inputs.
221+
Generate content from an existing no-code agent (formerly called no-code
222+
applications) with inputs.
221223
222224
Args:
223225
stream: Indicates whether the response should be streamed. Currently only supported for
@@ -248,7 +250,8 @@ def generate_content(
248250
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
249251
) -> ApplicationGenerateContentResponse | Stream[ApplicationGenerateContentChunk]:
250252
"""
251-
Generate content from an existing no-code application with inputs.
253+
Generate content from an existing no-code agent (formerly called no-code
254+
applications) with inputs.
252255
253256
Args:
254257
stream: Indicates whether the response should be streamed. Currently only supported for
@@ -340,8 +343,8 @@ async def retrieve(
340343
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
341344
) -> ApplicationRetrieveResponse:
342345
"""
343-
Retrieves detailed information for a specific no-code application, including its
344-
configuration and current status.
346+
Retrieves detailed information for a specific no-code agent (formerly called
347+
no-code applications), including its configuration and current status.
345348
346349
Args:
347350
extra_headers: Send extra headers
@@ -378,8 +381,8 @@ def list(
378381
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
379382
) -> AsyncPaginator[ApplicationListResponse, AsyncCursorPage[ApplicationListResponse]]:
380383
"""
381-
Retrieves a paginated list of no-code applications with optional filtering and
382-
sorting capabilities.
384+
Retrieves a paginated list of no-code agents (formerly called no-code
385+
applications) with optional filtering and sorting capabilities.
383386
384387
Args:
385388
after: Return results after this application ID for pagination.
@@ -437,7 +440,8 @@ async def generate_content(
437440
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
438441
) -> ApplicationGenerateContentResponse:
439442
"""
440-
Generate content from an existing no-code application with inputs.
443+
Generate content from an existing no-code agent (formerly called no-code
444+
applications) with inputs.
441445
442446
Args:
443447
stream: Indicates whether the response should be streamed. Currently only supported for
@@ -468,7 +472,8 @@ async def generate_content(
468472
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
469473
) -> AsyncStream[ApplicationGenerateContentChunk]:
470474
"""
471-
Generate content from an existing no-code application with inputs.
475+
Generate content from an existing no-code agent (formerly called no-code
476+
applications) with inputs.
472477
473478
Args:
474479
stream: Indicates whether the response should be streamed. Currently only supported for
@@ -499,7 +504,8 @@ async def generate_content(
499504
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
500505
) -> ApplicationGenerateContentResponse | AsyncStream[ApplicationGenerateContentChunk]:
501506
"""
502-
Generate content from an existing no-code application with inputs.
507+
Generate content from an existing no-code agent (formerly called no-code
508+
applications) with inputs.
503509
504510
Args:
505511
stream: Indicates whether the response should be streamed. Currently only supported for

src/writerai/resources/applications/graphs.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@ def update(
5959
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
6060
) -> ApplicationGraphsResponse:
6161
"""
62-
Updates the Knowledge Graphs listed and associates them with the no-code chat
63-
app to be used.
62+
Updates the Knowledge Graphs listed and associates them with the no-code agent.
6463
6564
Args:
6665
graph_ids: A list of Knowledge Graph IDs to associate with the application. Note that this
@@ -98,7 +97,8 @@ def list(
9897
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
9998
) -> ApplicationGraphsResponse:
10099
"""
101-
Retrieve Knowledge Graphs associated with a no-code chat application.
100+
Retrieve Knowledge Graphs associated with a no-code agent that has chat
101+
capabilities.
102102
103103
Args:
104104
extra_headers: Send extra headers
@@ -153,8 +153,7 @@ async def update(
153153
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
154154
) -> ApplicationGraphsResponse:
155155
"""
156-
Updates the Knowledge Graphs listed and associates them with the no-code chat
157-
app to be used.
156+
Updates the Knowledge Graphs listed and associates them with the no-code agent.
158157
159158
Args:
160159
graph_ids: A list of Knowledge Graph IDs to associate with the application. Note that this
@@ -192,7 +191,8 @@ async def list(
192191
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
193192
) -> ApplicationGraphsResponse:
194193
"""
195-
Retrieve Knowledge Graphs associated with a no-code chat application.
194+
Retrieve Knowledge Graphs associated with a no-code agent that has chat
195+
capabilities.
196196
197197
Args:
198198
extra_headers: Send extra headers

src/writerai/resources/applications/jobs.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ def create(
6363
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
6464
) -> JobCreateResponse:
6565
"""
66-
Generate content asynchronously from an existing application with inputs.
66+
Generate content asynchronously from an existing no-code agent (formerly called
67+
no-code applications) with inputs.
6768
6869
Args:
6970
inputs: A list of input objects to generate content for.
@@ -243,7 +244,8 @@ async def create(
243244
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
244245
) -> JobCreateResponse:
245246
"""
246-
Generate content asynchronously from an existing application with inputs.
247+
Generate content asynchronously from an existing no-code agent (formerly called
248+
no-code applications) with inputs.
247249
248250
Args:
249251
inputs: A list of input objects to generate content for.

0 commit comments

Comments
 (0)