Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
ddebowczyk committed Oct 15, 2024
1 parent f66ebc7 commit ab2ccc2
Show file tree
Hide file tree
Showing 6 changed files with 238 additions and 3 deletions.
61 changes: 61 additions & 0 deletions docs/cookbook/examples/extras/chain_of_summaries.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: 'Chain of Summaries'
docname: 'chain_of_summaries'
---

## Overview

This is an example of a simple summarization.

## Example

```php
<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');

use Cognesy\Instructor\Features\Schema\Attributes\Description;
use Cognesy\Instructor\Instructor;

$report = <<<EOT
[2021-09-01]
Acme Insurance project to implement SalesTech CRM solution is currently
in RED status due to delayed delivery of document production system, led
by 3rd party vendor - Alfatech. Customer (Acme) is discussing the resolution
with the vendor. Due to dependencies it will result in delay of the
ecommerce track by 2 sprints. System integrator (SysCorp) are working
to absorb some of the delay by deploying extra resources to speed up
development when the doc production is done. Another issue is that the
customer is not able to provide the test data for the ecommerce track.
SysCorp notified it will impact stabilization schedule unless resolved by
the end of the month. Steerco has been informed last week about the
potential impact of the issues, but insists on maintaining release schedule
due to marketing campaign already ongoing. Customer executives are asking
us - SalesTech team - to confirm SysCorp's assessment of the situation.
We're struggling with that due to communication issues - SysCorp team has
not shown up on 2 recent calls. Lack of insight has been escalated to
SysCorp's leadership team yesterday, but we've got no response yet. The
previously reported Integration Proxy connectivity issue which was blocking
policy track has been resolved on 2021-08-30 - the track is now GREEN.
Production deployment plan has been finalized on Aug 15th and awaiting
customer approval.
EOT;

class Summary {
#[Description('Project summary, not longer than 3 sentences')]
public string $summary = '';
#[Description('5 most relevant keywords extracted from the summary')]
public array $keywords = [];
}

$summary = (new Instructor)
->withConnection('openai')
->request(
input: $report,
responseModel: Summary::class,
)
->get();

dump($summary);
?>
```
56 changes: 56 additions & 0 deletions docs/cookbook/examples/extras/summary_with_llm.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: 'Simple content summary'
docname: 'summary_with_llm'
---

## Overview

This is an example of a simple summarization.

## Example

```php
<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');

use Cognesy\Instructor\Features\LLM\Inference;

$report = <<<EOT
[2021-09-01]
Acme Insurance project to implement SalesTech CRM solution is currently
in RED status due to delayed delivery of document production system, led
by 3rd party vendor - Alfatech. Customer (Acme) is discussing the resolution
with the vendor. Due to dependencies it will result in delay of the
ecommerce track by 2 sprints. System integrator (SysCorp) are working
to absorb some of the delay by deploying extra resources to speed up
development when the doc production is done. Another issue is that the
customer is not able to provide the test data for the ecommerce track.
SysCorp notified it will impact stabilization schedule unless resolved by
the end of the month. Steerco has been informed last week about the
potential impact of the issues, but insists on maintaining release schedule
due to marketing campaign already ongoing. Customer executives are asking
us - SalesTech team - to confirm SysCorp's assessment of the situation.
We're struggling with that due to communication issues - SysCorp team has
not shown up on 2 recent calls. Lack of insight has been escalated to
SysCorp's leadership team yesterday, but we've got no response yet. The
previously reported Integration Proxy connectivity issue which was blocking
policy track has been resolved on 2021-08-30 - the track is now GREEN.
Production deployment plan has been finalized on Aug 15th and awaiting
customer approval.
EOT;

$summary = (new Inference)
->withConnection('openai')
->create(
messages: [
['role' => 'user', 'content' => 'Content to summarize:'],
['role' => 'user', 'content' => $report],
['role' => 'user', 'content' => 'Concise summary of project report in 2-3 sentences:'],
]
)
->toText();

dump($summary);
?>
```
61 changes: 61 additions & 0 deletions docs/cookbook/prompting/misc/summary_with_keywords.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: 'Summary with Keywords'
docname: 'summary_with_keywords'
---

## Overview

This is an example of a simple summarization with keyword extraction.

## Example

```php
<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');

use Cognesy\Instructor\Features\Schema\Attributes\Description;
use Cognesy\Instructor\Instructor;

$report = <<<EOT
[2021-09-01]
Acme Insurance project to implement SalesTech CRM solution is currently
in RED status due to delayed delivery of document production system, led
by 3rd party vendor - Alfatech. Customer (Acme) is discussing the resolution
with the vendor. Due to dependencies it will result in delay of the
ecommerce track by 2 sprints. System integrator (SysCorp) are working
to absorb some of the delay by deploying extra resources to speed up
development when the doc production is done. Another issue is that the
customer is not able to provide the test data for the ecommerce track.
SysCorp notified it will impact stabilization schedule unless resolved by
the end of the month. Steerco has been informed last week about the
potential impact of the issues, but insists on maintaining release schedule
due to marketing campaign already ongoing. Customer executives are asking
us - SalesTech team - to confirm SysCorp's assessment of the situation.
We're struggling with that due to communication issues - SysCorp team has
not shown up on 2 recent calls. Lack of insight has been escalated to
SysCorp's leadership team yesterday, but we've got no response yet. The
previously reported Integration Proxy connectivity issue which was blocking
policy track has been resolved on 2021-08-30 - the track is now GREEN.
Production deployment plan has been finalized on Aug 15th and awaiting
customer approval.
EOT;

class Summary {
#[Description('Project summary, not longer than 3 sentences')]
public string $summary = '';
#[Description('5 most relevant keywords extracted from the summary')]
public array $keywords = [];
}

$summary = (new Instructor)
->withConnection('openai')
->request(
input: $report,
responseModel: Summary::class,
)
->get();

dump($summary);
?>
```
3 changes: 2 additions & 1 deletion docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,7 @@
"cookbook/examples/extras/llm_tools",
"cookbook/examples/extras/schema",
"cookbook/examples/extras/schema_dynamic",
"cookbook/examples/extras/summary_with_llm",
"cookbook/examples/extras/transcription_to_tasks",
"cookbook/examples/extras/translate_ui_fields",
"cookbook/examples/extras/web_to_objects"
Expand Down Expand Up @@ -247,7 +248,7 @@
"cookbook/prompting/misc/restate_instructions",
"cookbook/prompting/misc/rewrite_instructions",
"cookbook/prompting/misc/search_query_expansion",
"cookbook/prompting/misc/chain_of_summaries",
"cookbook/prompting/misc/summary_with_keywords",
"cookbook/prompting/misc/component_reuse",
"cookbook/prompting/misc/component_reuse_cot"
]
Expand Down
56 changes: 56 additions & 0 deletions examples/A05_Extras/SummaryLLM/run.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: 'Simple content summary'
docname: 'summary_with_llm'
---

## Overview

This is an example of a simple summarization.

## Example

```php
<?php
$loader = require 'vendor/autoload.php';
$loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');

use Cognesy\Instructor\Features\LLM\Inference;

$report = <<<EOT
[2021-09-01]
Acme Insurance project to implement SalesTech CRM solution is currently
in RED status due to delayed delivery of document production system, led
by 3rd party vendor - Alfatech. Customer (Acme) is discussing the resolution
with the vendor. Due to dependencies it will result in delay of the
ecommerce track by 2 sprints. System integrator (SysCorp) are working
to absorb some of the delay by deploying extra resources to speed up
development when the doc production is done. Another issue is that the
customer is not able to provide the test data for the ecommerce track.
SysCorp notified it will impact stabilization schedule unless resolved by
the end of the month. Steerco has been informed last week about the
potential impact of the issues, but insists on maintaining release schedule
due to marketing campaign already ongoing. Customer executives are asking
us - SalesTech team - to confirm SysCorp's assessment of the situation.
We're struggling with that due to communication issues - SysCorp team has
not shown up on 2 recent calls. Lack of insight has been escalated to
SysCorp's leadership team yesterday, but we've got no response yet. The
previously reported Integration Proxy connectivity issue which was blocking
policy track has been resolved on 2021-08-30 - the track is now GREEN.
Production deployment plan has been finalized on Aug 15th and awaiting
customer approval.
EOT;

$summary = (new Inference)
->withConnection('openai')
->create(
messages: [
['role' => 'user', 'content' => 'Content to summarize:'],
['role' => 'user', 'content' => $report],
['role' => 'user', 'content' => 'Concise summary of project report in 2-3 sentences:'],
]
)
->toText();

dump($summary);
?>
```
4 changes: 2 additions & 2 deletions examples/B07_Misc/Summary/run.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Chain of Summaries'
docname: 'chain_of_summaries'
title: 'Summary with Keywords'
docname: 'summary_with_keywords'
---

## Overview
Expand Down

0 comments on commit ab2ccc2

Please sign in to comment.