docs(api): updates to API spec

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 32
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-fab7a71148b6f413a4425ca9f2ce3d42557b65d35ab28c6f64daa7fce6d0ffe2.yml
-openapi_spec_hash: 0ead6944545bc40172176e15cc704633
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-994b51f2c7c776c2cd3d4e3c6900cc6291da87296cea27921ec709a459a41034.yml
+openapi_spec_hash: 1fdc6bb31a5464cebb4c579370764907
 config_hash: c0c9f57ab19252f82cf765939edc61de

api.md

@@ -123,7 +123,9 @@ from writerai.types import (
     Question,
     QuestionResponseChunk,
     GraphCreateResponse,
+    GraphRetrieveResponse,
     GraphUpdateResponse,
+    GraphListResponse,
     GraphDeleteResponse,
     GraphRemoveFileFromGraphResponse,
 )
@@ -132,9 +134,9 @@ from writerai.types import (
 Methods:
 
 - <code title="post /v1/graphs">client.graphs.<a href="./src/writerai/resources/graphs.py">create</a>(\*\*<a href="src/writerai/types/graph_create_params.py">params</a>) -> <a href="./src/writerai/types/graph_create_response.py">GraphCreateResponse</a></code>
-- <code title="get /v1/graphs/{graph_id}">client.graphs.<a href="./src/writerai/resources/graphs.py">retrieve</a>(graph_id) -> <a href="./src/writerai/types/graph.py">Graph</a></code>
+- <code title="get /v1/graphs/{graph_id}">client.graphs.<a href="./src/writerai/resources/graphs.py">retrieve</a>(graph_id) -> <a href="./src/writerai/types/graph_retrieve_response.py">GraphRetrieveResponse</a></code>
 - <code title="put /v1/graphs/{graph_id}">client.graphs.<a href="./src/writerai/resources/graphs.py">update</a>(graph_id, \*\*<a href="src/writerai/types/graph_update_params.py">params</a>) -> <a href="./src/writerai/types/graph_update_response.py">GraphUpdateResponse</a></code>
-- <code title="get /v1/graphs">client.graphs.<a href="./src/writerai/resources/graphs.py">list</a>(\*\*<a href="src/writerai/types/graph_list_params.py">params</a>) -> <a href="./src/writerai/types/graph.py">SyncCursorPage[Graph]</a></code>
+- <code title="get /v1/graphs">client.graphs.<a href="./src/writerai/resources/graphs.py">list</a>(\*\*<a href="src/writerai/types/graph_list_params.py">params</a>) -> <a href="./src/writerai/types/graph_list_response.py">SyncCursorPage[GraphListResponse]</a></code>
 - <code title="delete /v1/graphs/{graph_id}">client.graphs.<a href="./src/writerai/resources/graphs.py">delete</a>(graph_id) -> <a href="./src/writerai/types/graph_delete_response.py">GraphDeleteResponse</a></code>
 - <code title="post /v1/graphs/{graph_id}/file">client.graphs.<a href="./src/writerai/resources/graphs.py">add_file_to_graph</a>(graph_id, \*\*<a href="src/writerai/types/graph_add_file_to_graph_params.py">params</a>) -> <a href="./src/writerai/types/file.py">File</a></code>
 - <code title="post /v1/graphs/question">client.graphs.<a href="./src/writerai/resources/graphs.py">question</a>(\*\*<a href="src/writerai/types/graph_question_params.py">params</a>) -> <a href="./src/writerai/types/question.py">Question</a></code>

src/writerai/resources/applications/graphs.py

@@ -56,7 +56,7 @@ def update(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ApplicationGraphsResponse:
         """
-        Updates the Knowledge Graphs listed and associates them with the no-code agent.
+        Updates the list of Knowledge Graphs associated with a no-code chat agent.
 
         Args:
           graph_ids: A list of Knowledge Graph IDs to associate with the application. Note that this
@@ -150,7 +150,7 @@ async def update(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> ApplicationGraphsResponse:
         """
-        Updates the Knowledge Graphs listed and associates them with the no-code agent.
+        Updates the list of Knowledge Graphs associated with a no-code chat agent.
 
         Args:
           graph_ids: A list of Knowledge Graph IDs to associate with the application. Note that this

src/writerai/resources/chat.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import List
+from typing import List, Iterable
 from typing_extensions import Literal, overload
 
 import httpx
@@ -27,12 +27,13 @@
 from .._streaming import Stream, AsyncStream
 from ..pagination import SyncCursorPage, AsyncCursorPage
 from ..types.file import File
-from ..types.graph import Graph
 from .._base_client import AsyncPaginator, make_request_options
 from ..types.question import Question
+from ..types.graph_list_response import GraphListResponse
 from ..types.graph_create_response import GraphCreateResponse
 from ..types.graph_delete_response import GraphDeleteResponse
 from ..types.graph_update_response import GraphUpdateResponse
+from ..types.graph_retrieve_response import GraphRetrieveResponse
 from ..types.question_response_chunk import QuestionResponseChunk
 from ..types.graph_remove_file_from_graph_response import GraphRemoveFileFromGraphResponse
 
@@ -114,7 +115,7 @@ def retrieve(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Graph:
+    ) -> GraphRetrieveResponse:
         """
         Retrieve a Knowledge Graph.
 
@@ -134,7 +135,7 @@ def retrieve(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Graph,
+            cast_to=GraphRetrieveResponse,
         )
 
     def update(
@@ -143,6 +144,7 @@ def update(
         *,
         description: str | NotGiven = NOT_GIVEN,
         name: str | NotGiven = NOT_GIVEN,
+        urls: Iterable[graph_update_params.URL] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -160,6 +162,10 @@ def update(
           name: The name of the Knowledge Graph (max 255 characters). Omitting this field leaves
               the name unchanged.
 
+          urls: An array of web connector URLs to update for this Knowledge Graph. You can only
+              connect URLs to Knowledge Graphs with the type `web`. To clear the list of URLs,
+              set this field to an empty array.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -176,6 +182,7 @@ def update(
                 {
                     "description": description,
                     "name": name,
+                    "urls": urls,
                 },
                 graph_update_params.GraphUpdateParams,
             ),
@@ -198,7 +205,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> SyncCursorPage[Graph]:
+    ) -> SyncCursorPage[GraphListResponse]:
         """
         Retrieve a list of Knowledge Graphs.
 
@@ -225,7 +232,7 @@ def list(
         """
         return self._get_api_list(
             "/v1/graphs",
-            page=SyncCursorPage[Graph],
+            page=SyncCursorPage[GraphListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -241,7 +248,7 @@ def list(
                     graph_list_params.GraphListParams,
                 ),
             ),
-            model=Graph,
+            model=GraphListResponse,
         )
 
     def delete(
@@ -613,7 +620,7 @@ async def retrieve(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> Graph:
+    ) -> GraphRetrieveResponse:
         """
         Retrieve a Knowledge Graph.
 
@@ -633,7 +640,7 @@ async def retrieve(
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
-            cast_to=Graph,
+            cast_to=GraphRetrieveResponse,
         )
 
     async def update(
@@ -642,6 +649,7 @@ async def update(
         *,
         description: str | NotGiven = NOT_GIVEN,
         name: str | NotGiven = NOT_GIVEN,
+        urls: Iterable[graph_update_params.URL] | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -659,6 +667,10 @@ async def update(
           name: The name of the Knowledge Graph (max 255 characters). Omitting this field leaves
               the name unchanged.
 
+          urls: An array of web connector URLs to update for this Knowledge Graph. You can only
+              connect URLs to Knowledge Graphs with the type `web`. To clear the list of URLs,
+              set this field to an empty array.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -675,6 +687,7 @@ async def update(
                 {
                     "description": description,
                     "name": name,
+                    "urls": urls,
                 },
                 graph_update_params.GraphUpdateParams,
             ),
@@ -697,7 +710,7 @@ def list(
         extra_query: Query | None = None,
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
-    ) -> AsyncPaginator[Graph, AsyncCursorPage[Graph]]:
+    ) -> AsyncPaginator[GraphListResponse, AsyncCursorPage[GraphListResponse]]:
         """
         Retrieve a list of Knowledge Graphs.
 
@@ -724,7 +737,7 @@ def list(
         """
         return self._get_api_list(
             "/v1/graphs",
-            page=AsyncCursorPage[Graph],
+            page=AsyncCursorPage[GraphListResponse],
             options=make_request_options(
                 extra_headers=extra_headers,
                 extra_query=extra_query,
@@ -740,7 +753,7 @@ def list(
                     graph_list_params.GraphListParams,
                 ),
             ),
-            model=Graph,
+            model=GraphListResponse,
         )
 
     async def delete(

src/writerai/resources/graphs.py

@@ -65,15 +65,15 @@ def translate(
 
         Args:
           formality: Whether to use formal or informal language in the translation. See the
-              [list of languages that support formality](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#formality).
+              [list of languages that support formality](https://dev.writer.com/api-reference/translation-api/language-support#formality).
               If the language does not support formality, this parameter is ignored.
 
           length_control: Whether to control the length of the translated text. See the
-              [list of languages that support length control](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#length-control).
+              [list of languages that support length control](https://dev.writer.com/api-reference/translation-api/language-support#length-control).
               If the language does not support length control, this parameter is ignored.
 
           mask_profanity: Whether to mask profane words in the translated text. See the
-              [list of languages that do not support profanity masking](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#profanity-masking).
+              [list of languages that do not support profanity masking](https://dev.writer.com/api-reference/translation-api/language-support#profanity-masking).
               If the language does not support profanity masking, this parameter is ignored.
 
           model: The model to use for translation.
@@ -84,15 +84,15 @@ def translate(
               variant, the code appends the two-digit
               [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
               For example, Mexican Spanish is `es-MX`. See the
-              [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+              [list of supported languages and language codes](https://dev.writer.com/api-reference/translation-api/language-support).
 
           target_language_code: The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
               language code of the target language for the translation. For example, `en` for
               English, `zh` for Chinese, `fr` for French, `es` for Spanish. If the language
               has a variant, the code appends the two-digit
               [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
               For example, Mexican Spanish is `es-MX`. See the
-              [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+              [list of supported languages and language codes](https://dev.writer.com/api-reference/translation-api/language-support).
 
           text: The text to translate. Maximum of 100,000 words.
 
@@ -167,15 +167,15 @@ async def translate(
 
         Args:
           formality: Whether to use formal or informal language in the translation. See the
-              [list of languages that support formality](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#formality).
+              [list of languages that support formality](https://dev.writer.com/api-reference/translation-api/language-support#formality).
               If the language does not support formality, this parameter is ignored.
 
           length_control: Whether to control the length of the translated text. See the
-              [list of languages that support length control](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#length-control).
+              [list of languages that support length control](https://dev.writer.com/api-reference/translation-api/language-support#length-control).
               If the language does not support length control, this parameter is ignored.
 
           mask_profanity: Whether to mask profane words in the translated text. See the
-              [list of languages that do not support profanity masking](https://dev.writer.com/api-guides/api-reference/translation-api/language-support#profanity-masking).
+              [list of languages that do not support profanity masking](https://dev.writer.com/api-reference/translation-api/language-support#profanity-masking).
               If the language does not support profanity masking, this parameter is ignored.
 
           model: The model to use for translation.
@@ -186,15 +186,15 @@ async def translate(
               variant, the code appends the two-digit
               [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
               For example, Mexican Spanish is `es-MX`. See the
-              [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+              [list of supported languages and language codes](https://dev.writer.com/api-reference/translation-api/language-support).
 
           target_language_code: The [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)
               language code of the target language for the translation. For example, `en` for
               English, `zh` for Chinese, `fr` for French, `es` for Spanish. If the language
               has a variant, the code appends the two-digit
               [ISO-3166 country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
               For example, Mexican Spanish is `es-MX`. See the
-              [list of supported languages and language codes](https://dev.writer.com/api-guides/api-reference/translation-api/language-support).
+              [list of supported languages and language codes](https://dev.writer.com/api-reference/translation-api/language-support).
 
           text: The text to translate. Maximum of 100,000 words.
 

src/writerai/resources/translation.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 from .file import File as File
-from .graph import Graph as Graph
 from .shared import (
     Source as Source,
     Logprobs as Logprobs,
@@ -31,6 +30,7 @@
 from .file_upload_params import FileUploadParams as FileUploadParams
 from .file_retry_response import FileRetryResponse as FileRetryResponse
 from .graph_create_params import GraphCreateParams as GraphCreateParams
+from .graph_list_response import GraphListResponse as GraphListResponse
 from .graph_update_params import GraphUpdateParams as GraphUpdateParams
 from .model_list_response import ModelListResponse as ModelListResponse
 from .file_delete_response import FileDeleteResponse as FileDeleteResponse
@@ -47,6 +47,7 @@
 from .chat_completion_choice import ChatCompletionChoice as ChatCompletionChoice
 from .application_list_params import ApplicationListParams as ApplicationListParams
 from .chat_completion_message import ChatCompletionMessage as ChatCompletionMessage
+from .graph_retrieve_response import GraphRetrieveResponse as GraphRetrieveResponse
 from .question_response_chunk import QuestionResponseChunk as QuestionResponseChunk
 from .tool_ai_detect_response import ToolAIDetectResponse as ToolAIDetectResponse
 from .tool_parse_pdf_response import ToolParsePdfResponse as ToolParsePdfResponse

src/writerai/types/__init__.py

@@ -31,9 +31,9 @@ class Input(TypedDict, total=False):
 
     If the input type is "File upload", you must pass the `file_id` of an uploaded
     file. You cannot pass a file object directly. See the
-    [file upload endpoint](https://dev.writer.com/api-guides/api-reference/file-api/upload-files)
+    [file upload endpoint](https://dev.writer.com/api-reference/file-api/upload-files)
     for instructions on uploading files or the
-    [list files endpoint](https://dev.writer.com/api-guides/api-reference/file-api/get-all-files)
+    [list files endpoint](https://dev.writer.com/api-reference/file-api/get-all-files)
     for how to see a list of uploaded files and their IDs.
     """
 

src/writerai/types/application_generate_content_params.py

@@ -27,8 +27,8 @@ class Input(TypedDict, total=False):
 
     If the input type is "File upload", you must pass the `file_id` of an uploaded
     file. You cannot pass a file object directly. See the
-    [file upload endpoint](https://dev.writer.com/api-guides/api-reference/file-api/upload-files)
+    [file upload endpoint](https://dev.writer.com/api-reference/file-api/upload-files)
     for instructions on uploading files or the
-    [list files endpoint](https://dev.writer.com/api-guides/api-reference/file-api/get-all-files)
+    [list files endpoint](https://dev.writer.com/api-reference/file-api/get-all-files)
     for how to see a list of uploaded files and their IDs.
     """