Changelog

​

Knowledge Graph query configuration and inline citations

​

New query configuration parameters

• inline_citations: Enable inline citations within response text, showing which sources support each part of the response
• search_weight: Control the balance between keyword and semantic search (0-100, default: 50)
• max_subquestions: Set the maximum number of sub-questions for complex queries (1-10, default: 6)
• grounding_level: Control how closely responses match source material (0.0-1.0, default: 0.0)
• max_snippets: Set the number of text snippets to retrieve (5-25 recommended, default: 30)
• max_tokens: Control the maximum response length (100-8000, default: 4000)
• keyword_threshold: Set keyword matching strictness (0.0-1.0, default: 0.7)
• semantic_threshold: Set semantic similarity requirements (0.0-1.0, default: 0.7)

​

Inline citations

​

Usage examples

curl --location --request POST 'https://api.writer.com/v1/chat/completions' \
  --header "Authorization: Bearer $WRITER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "model": "palmyra-x5",
    "messages": [{"role": "user", "content": "What are our key features?"}],
    "tools": [{
      "type": "graph",
      "function": {
        "name": "search_knowledge",
        "description": "Search company knowledge base",
        "graph_ids": ["your-graph-id"],
        "subqueries": true,
        "query_config": {
          "inline_citations": true,
          "search_weight": 60,
          "grounding_level": 0.2
        }
      }
    }]
  }'

curl --location --request POST 'https://api.writer.com/v1/graphs/question' \
  --header "Authorization: Bearer $WRITER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "graph_ids": ["your-graph-id"],
    "question": "What are our key features?",
    "query_config": {
      "inline_citations": true,
      "search_weight": 60,
      "grounding_level": 0.2
    }
  }'

​

Released version 2.3.1 of the Python and Node SDKs

​

langchain-writer v0.3.3

​

Released version 2.3.0 of the Python and Node SDKs

• Web search API
• Web search tool for chat completions
• Web connector URLs for Knowledge Graphs
• Image support in chat completions

​

Web search and web connector URLs

• Web search tool API
• Web search tool for chat completions
• Web connector URLs for Knowledge Graphs

​

Web search API

• Search for current information and news
• Filter results by domain, time range, and geographic location
• Control search depth and result comprehensiveness
• Support for both general and news-specific searches

​

Web search tool for chat completions

​

Web connector URLs for Knowledge Graphs

• Process single pages or entire sub-pages
• Monitor the status of URL processing
• Exclude specific URLs from processing
• Query web content through your Knowledge Graph

​

Image support in chat completions

​

References

• Web search tool: API reference and guide
• Web search tool for chat completions: API reference and guide
• Web connector URLs for Knowledge Graphs: API reference and guide
• Chat with images: API reference and guide

​

Vision chat support for Palmyra X5

• Send messages containing both text and images
• Support for multiple images in a single message
• Use of data URLs for local images
• Natural conversation flow with visual context

curl --location 'https://api.writer.com/v1/chat' \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $WRITER_API_KEY" \
--data '{
  "model": "palmyra-x5",
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "What do you see in this image?"
        },
        {
          "type": "image_url",
          "image_url": {
            "url": "https://example.com/image.jpg"
          }
        }
      ]
    }
  ]
}'

​

Web search and web connector URLs released

• Web search tool API
• Web search tool for chat completions
• Web connector URLs for Knowledge Graphs

​

Web search tool API

• Search for current information and news
• Filter results by domain, time range, and geographic location
• Control search depth and result comprehensiveness
• Support for both general and news-specific searches

​

Web search tool for chat completions

​

Web connector URLs for Knowledge Graphs

• Process single pages or entire sub-pages
• Monitor the status of URL processing
• Exclude specific URLs from processing
• Query web content through your Knowledge Graph

• Web search tool API documentation
• Web search tool for chat completions
• Web connector URLs for Knowledge Graphs

​

Writer Strands Agents integration released

​

Released version 2.2.1 of the Python and Node SDKs

files = client.files.list(file_types="pdf,docx")

​

Writer Instructor integration now supports JSON output

​

langchain-writer v0.3.1

​

Filter files by type

curl --location --request GET "https://api.writer.com/v1/files?file_types=txt,pdf,docx" \
  --header "Authorization: Bearer $WRITER_API_KEY" \

​

Released version 2.2.0 of the Python and Node SDKs

• Structured output for the chat completions endpoint
• AI detection endpoint
• Text translation endpoint
• The text translation tool for chat completions

• Structured output for chat completions
• AI detection
• Text translation
• The text translation tool

​

Palmyra X5 and X4 now available on Amazon Bedrock

• Guide for setting up and using Palmyra X5 and X4 on Amazon Bedrock
• AWS blog post about using Palmyra X5 and X4 on Amazon Bedrock

​

Palmyra X5 model now available

• Support documentation: Classify requests, assess urgency, assign a human review, stage updates in a CMS, and publish after approval.
• Fund reporting: Streamline the analysis and preparation of detailed reports on the performance and status of investment funds, using reporting and research data pulled in from third-party systems
• Content lifecycle management: Flag content that could be outdated, generate suggested revisions, and share them for human review.

• Customer feedback analysis: Analyze large volumes of customer feedback to identify common themes, summarize sentiments, and generate actionable insights.
• Research and development: Process and summarize multiple technical reports, research papers, and experimental data, accelerating innovation and product development.
• Financial reporting: Process and summarize annual reports, SEC filings, and market analysis reports together at once to extract financial data, identify trends, and generate executive summaries.
• Legal document analysis: Analyze lengthy legal documents, including contracts, patents, and compliance reports, to identify key clauses, flag potential risks, and ensure regulatory compliance.
• Medical records analysis: Analyze and summarize large files of medical records containing structured and unstructured data, including patient records, clinical trial reports, audit reports, and more.

​

Writer LangChain integration now supports Python 3.9

​

Terminology updates

​

Released version 2.1.0 of the Python and Node SDKs

• Streaming helpers in Python
• Streaming helpers in Node

​

New cookbooks for Palmyra models

• Palmyra Creative
• Palmyra Fin
• Palmyra Med

​

Palmyra Vision now available via the API

curl -X POST \
  'https://api.writer.com/v1/vision' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $WRITER_API_KEY" \
  --data-raw '{
    "model": "palmyra-vision",
    "prompt": "What's the difference between the image {{image_1}} and the image {{image_2}}?",
    "variables": [
      {"name": "image_1", "file_id": "f1234"},
      {"name": "image_2", "file_id": "f5678"}
    ]
  }'

• Extracting handwritten text
• Interpreting charts and graphs
• Generating product descriptions

​

Released langchain-writer v0.1.0

• Updated tool binding to align with standard LangChain tool calling conventions.
• Added a new NoCodeAppTool tool for using no-code applications as tools.
• Added a new LLMTool tool for delegating to a specific Palmyra model.

​

New cookbooks for tool calling and no-code applications

• Generating content from no-code applications with the SDK
• Delegating a medical question to the palmyra-med model
• Using the Knowledge Graph chat tool

​

Palmyra Fin model updates

​

Released Writer LangChain integration

• The ChatWriter model for text generation
• Tool calling capabilities, including the GraphTool for retrieving information from a Knowledge Graph
• Additional tools like the PDFParser for parsing PDFs and the WriterTextSplitter for intelligent text splitting

​

Released version 2.0.0 of the Python and Node SDKs

• Model delegation tool: A prebuilt, remotely executed tool that lets you delegate domain-specific requests to the appropriate Palmyra model. For example, if your application has finance questions, you can use the tool to allow Palmyra X4 to delegate these questions to Palmyra Financial. Read more in our model delegation guide.
• Retrieve application details: Retrieve details for all of your no-code applications. Programmatically retrieve application inputs rather than relying on the AI Studio UI. This pairs well with our guide on using no-code applications as tools.
• Async jobs: Trigger no-code application content generation asynchronously and retrieve or retry the job at a later time. This is great for long-running no-code applications, such as research assistant applications. To learn more, check out the guide on async jobs.
• Associate Knowledge Graphs with chat applications: Retrieve or update which Knowledge Graphs are associated with no-code chat applications.

• Python
• Node

​

Python SDK

• The types.chat_completion_chunk.Message type has been moved to its own model: types.chat_completion_message.
• types.chat.ChoiceLogprobsContent, ChoiceLogprobsRefusal, ChoiceLogprobsContentTopLogprob, and ChoiceLogprobsRefusalTopLogprob have all been deduplicated and replaced by a shared model types.shared.logprobs_token.LogprobsToken.

​

Node SDK

​

Released version 1.6.1 of the Python SDK

• Fixed a typing bug where the content field in the File did not accept the correct FileTypes values.

​

Released Python SDK version 1.6.0 and Node SDK version 1.5.0

• Added streaming support to the applications content generation endpoint and updated the No-code applications guide to reflect this.

​

Released Python SDK version 1.5.0

• Added new functionality via manual API updates
• Fixed compatibility with the latest httpx 0.28.0 release
• Improved handling of deprecated arguments (transport, proxies) to maintain backward compatibility
• Fixed compatibility issues with Pydantic model_dump method when warnings are passed
• Removed the now unused cached-property dependency, as we now rely on the standard library implementation for Python 3.8+
• Enhanced logging documentation in README, adding information about the ‘info’ log level
• Updated the recommended log level from ‘debug’ to ‘info’ for standard usage
• Fixed code formatting for better readability and consistency
• Excluded test files from mypy checks to avoid false positives
• Updated internal compatibility layer for better type checking
• Improved error handling for deprecated client configuration options

​

Released Python and Node SDK versions 1.4.0

• Updated the default timeout on the Writer client to three minutes.