Document streaming helping methods and add change record
>>> [!note] Migrated issue <!-- Drupal.org comment --> <!-- Migrated from issue #3579930. --> Reported by: [marcus_johansson](https://www.drupal.org/user/385947) Related to !1433 >>> <p>[Tracker]<br> <strong>Update Summary: </strong>[One-line status update for stakeholders]<br> <strong>Short Description: </strong>[One-line issue summary for stakeholders]<br> <strong>Check-in Date: </strong>MM/DD/YYYY<br> <em>Metadata is used by the <a href="https://www.drupalstarforge.ai/" title="AI Tracker">AI Tracker.</a> Docs and additional fields <a href="https://www.drupalstarforge.ai/ai-dashboard/docs" title="AI Issue Tracker Documentation">here</a>.</em><br> [/Tracker]</p> <h3 id="summary-problem-motivation">Problem/Motivation</h3> <p>Since 1.2.x we are using doIterate as the method that is exposed to the providers to use for their stream iterators. This is not documented and no change record can be found for this.</p> <p>We should add that when targetting 1.2.0 or above, one should remove the getIterator object and instead use the doIterate.</p> <p>We should also document that if the provider is OpenAI compatible and no custom logic exists, then OpenAiTypeStreamedChatMessageIterator can be used.</p> <h3 id="summary-proposed-resolution">Proposed resolution</h3> <p>Document this under creating a provider section.</p> <h3 id="summary-remaining-tasks">Remaining tasks</h3> <h3>Optional: Other details as applicable (e.g., User interface changes, API changes, Data model changes)</h3> <h3 id="summary-ai-usage">AI usage (if applicable)</h3> <p>[ ] AI Assisted Issue<br> This issue was generated with AI assistance, but was reviewed and refined by the creator.</p> <p>[ ] AI Assisted Code<br> This code was mainly generated by a human, with AI autocompleting or parts AI generated, but under full human supervision.</p> <p>[ ] AI Generated Code<br> This code was mainly generated by an AI with human guidance, and reviewed, tested, and refined by a human.</p> <p>[ ] Vibe Coded<br> This code was generated by an AI and has only been functionally tested.</p>
issue