feat(api): add citations (#668)

anthropics · Jan 23, 2025 · 1fef177 · 1fef177
1 parent a1c7fcd
commit 1fef177
Show file tree

Hide file tree

Showing 16 changed files with 538 additions and 17 deletions.
diff --git a/.stats.yml b/.stats.yml
@@ -1,2 +1,2 @@
 configured_endpoints: 21
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/anthropic-75f0573c3d6d79650bcbd8b1b4fcf93ce146d567afeb1061cd4afccf8d1d6799.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/anthropic-7270ee0a79d885681ee507414608229f61c27f47c40f355dcd210b38aa7cddf1.yml
diff --git a/api.md b/api.md
@@ -22,9 +22,19 @@ Types:
 
 - <code><a href="./src/resources/messages/messages.ts">Base64PDFSource</a></code>
 - <code><a href="./src/resources/messages/messages.ts">CacheControlEphemeral</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationCharLocation</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationCharLocationParam</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationContentBlockLocation</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationContentBlockLocationParam</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationPageLocation</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationPageLocationParam</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationsConfigParam</a></code>
+- <code><a href="./src/resources/messages/messages.ts">CitationsDelta</a></code>
 - <code><a href="./src/resources/messages/messages.ts">ContentBlock</a></code>
 - <code><a href="./src/resources/messages/messages.ts">ContentBlockDeltaEvent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">ContentBlockParam</a></code>
+- <code><a href="./src/resources/messages/messages.ts">ContentBlockSource</a></code>
+- <code><a href="./src/resources/messages/messages.ts">ContentBlockSourceContent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">ContentBlockStartEvent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">ContentBlockStopEvent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">DocumentBlockParam</a></code>
@@ -40,6 +50,7 @@ Types:
 - <code><a href="./src/resources/messages/messages.ts">MessageTokensCount</a></code>
 - <code><a href="./src/resources/messages/messages.ts">Metadata</a></code>
 - <code><a href="./src/resources/messages/messages.ts">Model</a></code>
+- <code><a href="./src/resources/messages/messages.ts">PlainTextSource</a></code>
 - <code><a href="./src/resources/messages/messages.ts">RawContentBlockDeltaEvent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">RawContentBlockStartEvent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">RawContentBlockStopEvent</a></code>
@@ -49,6 +60,8 @@ Types:
 - <code><a href="./src/resources/messages/messages.ts">RawMessageStreamEvent</a></code>
 - <code><a href="./src/resources/messages/messages.ts">TextBlock</a></code>
 - <code><a href="./src/resources/messages/messages.ts">TextBlockParam</a></code>
+- <code><a href="./src/resources/messages/messages.ts">TextCitation</a></code>
+- <code><a href="./src/resources/messages/messages.ts">TextCitationParam</a></code>
 - <code><a href="./src/resources/messages/messages.ts">TextDelta</a></code>
 - <code><a href="./src/resources/messages/messages.ts">Tool</a></code>
 - <code><a href="./src/resources/messages/messages.ts">ToolChoice</a></code>
@@ -135,15 +148,26 @@ Types:
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaBase64PDFBlock</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaBase64PDFSource</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaCacheControlEphemeral</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationCharLocation</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationCharLocationParam</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationContentBlockLocation</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationContentBlockLocationParam</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationPageLocation</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationPageLocationParam</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationsConfigParam</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaCitationsDelta</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlock</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlockParam</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlockSource</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaContentBlockSourceContent</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaImageBlockParam</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaInputJSONDelta</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaMessage</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaMessageDeltaUsage</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaMessageParam</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaMessageTokensCount</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaMetadata</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaPlainTextSource</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockDeltaEvent</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockStartEvent</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaRawContentBlockStopEvent</a></code>
@@ -153,6 +177,8 @@ Types:
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaRawMessageStreamEvent</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaTextBlock</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaTextBlockParam</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextCitation</a></code>
+- <code><a href="./src/resources/beta/messages/messages.ts">BetaTextCitationParam</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaTextDelta</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaTool</a></code>
 - <code><a href="./src/resources/beta/messages/messages.ts">BetaToolBash20241022</a></code>

diff --git a/src/index.ts b/src/index.ts
@@ -33,9 +33,19 @@ import {
 import {
   Base64PDFSource,
   CacheControlEphemeral,
+  CitationCharLocation,
+  CitationCharLocationParam,
+  CitationContentBlockLocation,
+  CitationContentBlockLocationParam,
+  CitationPageLocation,
+  CitationPageLocationParam,
+  CitationsConfigParam,
+  CitationsDelta,
   ContentBlock,
   ContentBlockDeltaEvent,
   ContentBlockParam,
+  ContentBlockSource,
+  ContentBlockSourceContent,
   ContentBlockStartEvent,
   ContentBlockStopEvent,
   DocumentBlockParam,
@@ -57,6 +67,7 @@ import {
   Messages,
   Metadata,
   Model,
+  PlainTextSource,
   RawContentBlockDeltaEvent,
   RawContentBlockStartEvent,
   RawContentBlockStopEvent,
@@ -66,6 +77,8 @@ import {
   RawMessageStreamEvent,
   TextBlock,
   TextBlockParam,
+  TextCitation,
+  TextCitationParam,
   TextDelta,
   Tool,
   ToolChoice,
@@ -322,9 +335,19 @@ export declare namespace Anthropic {
     Messages as Messages,
     type Base64PDFSource as Base64PDFSource,
     type CacheControlEphemeral as CacheControlEphemeral,
+    type CitationCharLocation as CitationCharLocation,
+    type CitationCharLocationParam as CitationCharLocationParam,
+    type CitationContentBlockLocation as CitationContentBlockLocation,
+    type CitationContentBlockLocationParam as CitationContentBlockLocationParam,
+    type CitationPageLocation as CitationPageLocation,
+    type CitationPageLocationParam as CitationPageLocationParam,
+    type CitationsConfigParam as CitationsConfigParam,
+    type CitationsDelta as CitationsDelta,
     type ContentBlock as ContentBlock,
     type ContentBlockDeltaEvent as ContentBlockDeltaEvent,
     type ContentBlockParam as ContentBlockParam,
+    type ContentBlockSource as ContentBlockSource,
+    type ContentBlockSourceContent as ContentBlockSourceContent,
     type ContentBlockStartEvent as ContentBlockStartEvent,
     type ContentBlockStopEvent as ContentBlockStopEvent,
     type DocumentBlockParam as DocumentBlockParam,
@@ -340,6 +363,7 @@ export declare namespace Anthropic {
     type MessageTokensCount as MessageTokensCount,
     type Metadata as Metadata,
     type Model as Model,
+    type PlainTextSource as PlainTextSource,
     type RawContentBlockDeltaEvent as RawContentBlockDeltaEvent,
     type RawContentBlockStartEvent as RawContentBlockStartEvent,
     type RawContentBlockStopEvent as RawContentBlockStopEvent,
@@ -349,6 +373,8 @@ export declare namespace Anthropic {
     type RawMessageStreamEvent as RawMessageStreamEvent,
     type TextBlock as TextBlock,
     type TextBlockParam as TextBlockParam,
+    type TextCitation as TextCitation,
+    type TextCitationParam as TextCitationParam,
     type TextDelta as TextDelta,
     type Tool as Tool,
     type ToolChoice as ToolChoice,

diff --git a/src/resources/beta/beta.ts b/src/resources/beta/beta.ts
@@ -8,15 +8,26 @@ import {
   BetaBase64PDFBlock,
   BetaBase64PDFSource,
   BetaCacheControlEphemeral,
+  BetaCitationCharLocation,
+  BetaCitationCharLocationParam,
+  BetaCitationContentBlockLocation,
+  BetaCitationContentBlockLocationParam,
+  BetaCitationPageLocation,
+  BetaCitationPageLocationParam,
+  BetaCitationsConfigParam,
+  BetaCitationsDelta,
   BetaContentBlock,
   BetaContentBlockParam,
+  BetaContentBlockSource,
+  BetaContentBlockSourceContent,
   BetaImageBlockParam,
   BetaInputJSONDelta,
   BetaMessage,
   BetaMessageDeltaUsage,
   BetaMessageParam,
   BetaMessageTokensCount,
   BetaMetadata,
+  BetaPlainTextSource,
   BetaRawContentBlockDeltaEvent,
   BetaRawContentBlockStartEvent,
   BetaRawContentBlockStopEvent,
@@ -26,6 +37,8 @@ import {
   BetaRawMessageStreamEvent,
   BetaTextBlock,
   BetaTextBlockParam,
+  BetaTextCitation,
+  BetaTextCitationParam,
   BetaTextDelta,
   BetaTool,
   BetaToolBash20241022,
@@ -163,15 +176,26 @@ export declare namespace Beta {
     type BetaBase64PDFBlock as BetaBase64PDFBlock,
     type BetaBase64PDFSource as BetaBase64PDFSource,
     type BetaCacheControlEphemeral as BetaCacheControlEphemeral,
+    type BetaCitationCharLocation as BetaCitationCharLocation,
+    type BetaCitationCharLocationParam as BetaCitationCharLocationParam,
+    type BetaCitationContentBlockLocation as BetaCitationContentBlockLocation,
+    type BetaCitationContentBlockLocationParam as BetaCitationContentBlockLocationParam,
+    type BetaCitationPageLocation as BetaCitationPageLocation,
+    type BetaCitationPageLocationParam as BetaCitationPageLocationParam,
+    type BetaCitationsConfigParam as BetaCitationsConfigParam,
+    type BetaCitationsDelta as BetaCitationsDelta,
     type BetaContentBlock as BetaContentBlock,
     type BetaContentBlockParam as BetaContentBlockParam,
+    type BetaContentBlockSource as BetaContentBlockSource,
+    type BetaContentBlockSourceContent as BetaContentBlockSourceContent,
     type BetaImageBlockParam as BetaImageBlockParam,
     type BetaInputJSONDelta as BetaInputJSONDelta,
     type BetaMessage as BetaMessage,
     type BetaMessageDeltaUsage as BetaMessageDeltaUsage,
     type BetaMessageParam as BetaMessageParam,
     type BetaMessageTokensCount as BetaMessageTokensCount,
     type BetaMetadata as BetaMetadata,
+    type BetaPlainTextSource as BetaPlainTextSource,
     type BetaRawContentBlockDeltaEvent as BetaRawContentBlockDeltaEvent,
     type BetaRawContentBlockStartEvent as BetaRawContentBlockStartEvent,
     type BetaRawContentBlockStopEvent as BetaRawContentBlockStopEvent,
@@ -181,6 +205,8 @@ export declare namespace Beta {
     type BetaRawMessageStreamEvent as BetaRawMessageStreamEvent,
     type BetaTextBlock as BetaTextBlock,
     type BetaTextBlockParam as BetaTextBlockParam,
+    type BetaTextCitation as BetaTextCitation,
+    type BetaTextCitationParam as BetaTextCitationParam,
     type BetaTextDelta as BetaTextDelta,
     type BetaTool as BetaTool,
     type BetaToolBash20241022 as BetaToolBash20241022,

diff --git a/src/resources/beta/index.ts b/src/resources/beta/index.ts
@@ -21,15 +21,26 @@ export {
   type BetaBase64PDFBlock,
   type BetaBase64PDFSource,
   type BetaCacheControlEphemeral,
+  type BetaCitationCharLocation,
+  type BetaCitationCharLocationParam,
+  type BetaCitationContentBlockLocation,
+  type BetaCitationContentBlockLocationParam,
+  type BetaCitationPageLocation,
+  type BetaCitationPageLocationParam,
+  type BetaCitationsConfigParam,
+  type BetaCitationsDelta,
   type BetaContentBlock,
   type BetaContentBlockParam,
+  type BetaContentBlockSource,
+  type BetaContentBlockSourceContent,
   type BetaImageBlockParam,
   type BetaInputJSONDelta,
   type BetaMessage,
   type BetaMessageDeltaUsage,
   type BetaMessageParam,
   type BetaMessageTokensCount,
   type BetaMetadata,
+  type BetaPlainTextSource,
   type BetaRawContentBlockDeltaEvent,
   type BetaRawContentBlockStartEvent,
   type BetaRawContentBlockStopEvent,
@@ -39,6 +50,8 @@ export {
   type BetaRawMessageStreamEvent,
   type BetaTextBlock,
   type BetaTextBlockParam,
+  type BetaTextCitation,
+  type BetaTextCitationParam,
   type BetaTextDelta,
   type BetaTool,
   type BetaToolBash20241022,

diff --git a/src/resources/beta/messages/batches.ts b/src/resources/beta/messages/batches.ts
@@ -86,9 +86,10 @@ export class Batches extends APIResource {
   }
 
   /**
-   * This endpoint is idempotent and can be used to poll for Message Batch
-   * completion. To access the results of a Message Batch, make a request to the
-   * `results_url` field in the response.
+   * Delete a Message Batch.
+   *
+   * Message Batches can only be deleted once they've finished processing. If you'd
+   * like to delete an in-progress batch, you must first cancel it.
    */
   delete(
     messageBatchId: string,

diff --git a/src/resources/beta/messages/index.ts b/src/resources/beta/messages/index.ts
@@ -24,15 +24,26 @@ export {
   type BetaBase64PDFBlock,
   type BetaBase64PDFSource,
   type BetaCacheControlEphemeral,
+  type BetaCitationCharLocation,
+  type BetaCitationCharLocationParam,
+  type BetaCitationContentBlockLocation,
+  type BetaCitationContentBlockLocationParam,
+  type BetaCitationPageLocation,
+  type BetaCitationPageLocationParam,
+  type BetaCitationsConfigParam,
+  type BetaCitationsDelta,
   type BetaContentBlock,
   type BetaContentBlockParam,
+  type BetaContentBlockSource,
+  type BetaContentBlockSourceContent,
   type BetaImageBlockParam,
   type BetaInputJSONDelta,
   type BetaMessage,
   type BetaMessageDeltaUsage,
   type BetaMessageParam,
   type BetaMessageTokensCount,
   type BetaMetadata,
+  type BetaPlainTextSource,
   type BetaRawContentBlockDeltaEvent,
   type BetaRawContentBlockStartEvent,
   type BetaRawContentBlockStopEvent,
@@ -42,6 +53,8 @@ export {
   type BetaRawMessageStreamEvent,
   type BetaTextBlock,
   type BetaTextBlockParam,
+  type BetaTextCitation,
+  type BetaTextCitationParam,
   type BetaTextDelta,
   type BetaTool,
   type BetaToolBash20241022,