Summarize (v1 API)

This API is marked as “Legacy” and is no longer maintained. Follow the migration guide to start using the Chat API.

Generates a summary in English for a given text.

Headers

X-Client-NamestringOptional

The name of the project that is making the request.

Request

This endpoint expects an object.

textstringRequired

The text to generate a summary for. Can be up to 100,000 characters long. Currently the only supported language is English.

lengthenumOptionalDefaults to medium

Allowed values: shortmediumlong

One of short, medium, long, or auto defaults to auto. Indicates the approximate length of the summary. If auto is selected, the best option will be picked based on the input text.

format"paragraph" or "bullets"OptionalDefaults to paragraph

Allowed values: paragraphbullets

One of paragraph, bullets, or auto, defaults to auto. Indicates the style in which the summary will be delivered - in a free form paragraph or in bullet points. If auto is selected, the best option will be picked based on the input text.

modelstringOptional

The identifier of the model to generate the summary with. Currently available models are command (default), command-nightly (experimental), command-light, and command-light-nightly (experimental). Smaller, “light” models are faster, while larger models will perform better.

extractivenessenumOptionalDefaults to low

Allowed values: lowmediumhigh

One of low, medium, high, or auto, defaults to auto. Controls how close to the original text the summary is. high extractiveness summaries will lean towards reusing sentences verbatim, while low extractiveness summaries will tend to paraphrase more. If auto is selected, the best option will be picked based on the input text.

temperaturedoubleOptional

Ranges from 0 to 5. Controls the randomness of the output. Lower values tend to generate more “predictable” output, while higher values tend to generate more “creative” output. The sweet spot is typically between 0 and 1.

additional_commandstringOptional

A free-form instruction for modifying how the summaries get generated. Should complete the sentence “Generate a summary _“. Eg. “focusing on the next steps” or “written by Yoda”

Response

This endpoint returns an object.

idstringOptional

Generated ID for the summary

summarystringOptional

Generated summary for the text

metaobjectOptional

1 import cohere 2 3 co = cohere.Client() 4 5 text = ( 6 "Ice cream is a sweetened frozen food typically eaten as a snack or dessert. " 7 "It may be made from milk or cream and is flavoured with a sweetener, " 8 "either sugar or an alternative, and a spice, such as cocoa or vanilla, " 9 "or with fruit such as strawberries or peaches. " 10 "It can also be made by whisking a flavored cream base and liquid nitrogen together. " 11 "Food coloring is sometimes added, in addition to stabilizers. " 12 "The mixture is cooled below the freezing point of water and stirred to incorporate air spaces " 13 "and to prevent detectable ice crystals from forming. The result is a smooth, " 14 "semi-solid foam that is solid at very low temperatures (below 2 °C or 35 °F). " 15 "It becomes more malleable as its temperature increases.\n\n" 16 'The meaning of the name "ice cream" varies from one country to another. ' 17 'In some countries, such as the United States, "ice cream" applies only to a specific variety, ' 18 "and most governments regulate the commercial use of the various terms according to the " 19 "relative quantities of the main ingredients, notably the amount of cream. " 20 "Products that do not meet the criteria to be called ice cream are sometimes labelled " 21 '"frozen dairy dessert" instead. In other countries, such as Italy and Argentina, ' 22 "one word is used fo\r all variants. Analogues made from dairy alternatives, " 23 "such as goat's or sheep's milk, or milk substitutes " 24 "(e.g., soy, cashew, coconut, almond milk or tofu), are available for those who are " 25 "lactose intolerant, allergic to dairy protein or vegan." 26 ) 27 28 response = co.summarize( 29 text=text, 30 ) 31 print(response)

1 { 2 "id": "aa0b828e-f9cf-484d-a84d-cb62f556e841", 3 "summary": "Ice cream is a frozen dessert made by whipping a cream base and liquid nitrogen together. It is then flavoured with sweeteners, spices and fruits. Ice cream can also be made using alternative milks, such as soy or almond, for those who are lactose intolerant or vegan.", 4 "meta": { 5 "api_version": { 6 "version": "1" 7 }, 8 "billed_units": { 9 "input_tokens": 321, 10 "output_tokens": 55 11 } 12 } 13 }

1	import cohere
2
3	co = cohere.Client()
4
5	text = (
6	"Ice cream is a sweetened frozen food typically eaten as a snack or dessert. "
7	"It may be made from milk or cream and is flavoured with a sweetener, "
8	"either sugar or an alternative, and a spice, such as cocoa or vanilla, "
9	"or with fruit such as strawberries or peaches. "
10	"It can also be made by whisking a flavored cream base and liquid nitrogen together. "
11	"Food coloring is sometimes added, in addition to stabilizers. "
12	"The mixture is cooled below the freezing point of water and stirred to incorporate air spaces "
13	"and to prevent detectable ice crystals from forming. The result is a smooth, "
14	"semi-solid foam that is solid at very low temperatures (below 2 °C or 35 °F). "
15	"It becomes more malleable as its temperature increases.\n\n"
16	'The meaning of the name "ice cream" varies from one country to another. '
17	'In some countries, such as the United States, "ice cream" applies only to a specific variety, '
18	"and most governments regulate the commercial use of the various terms according to the "
19	"relative quantities of the main ingredients, notably the amount of cream. "
20	"Products that do not meet the criteria to be called ice cream are sometimes labelled "
21	'"frozen dairy dessert" instead. In other countries, such as Italy and Argentina, '
22	"one word is used fo\r all variants. Analogues made from dairy alternatives, "
23	"such as goat's or sheep's milk, or milk substitutes "
24	"(e.g., soy, cashew, coconut, almond milk or tofu), are available for those who are "
25	"lactose intolerant, allergic to dairy protein or vegan."
26	)
27
28	response = co.summarize(
29	text=text,
30	)
31	print(response)

1	{
2	"id": "aa0b828e-f9cf-484d-a84d-cb62f556e841",
3	"summary": "Ice cream is a frozen dessert made by whipping a cream base and liquid nitrogen together. It is then flavoured with sweeteners, spices and fruits. Ice cream can also be made using alternative milks, such as soy or almond, for those who are lactose intolerant or vegan.",
4	"meta": {
5	"api_version": {
6	"version": "1"
7	},
8	"billed_units": {
9	"input_tokens": 321,
10	"output_tokens": 55
11	}
12	}
13	}