diff --git a/asyncapi.yml b/asyncapi.yml index f41ae18..cd93673 100644 --- a/asyncapi.yml +++ b/asyncapi.yml @@ -118,6 +118,7 @@ components: schemas: RealtimeBaseMessage: type: object + x-fern-sdk-group-name: realtime required: - message_type properties: @@ -125,6 +126,7 @@ components: description: Describes the type of the message $ref: "#/components/schemas/MessageType" RealtimeMessage: + x-fern-sdk-group-name: realtime oneOf: - $ref: "#/components/schemas/SessionBegins" - $ref: "#/components/schemas/PartialTranscript" @@ -133,6 +135,7 @@ components: - $ref: "#/components/schemas/RealtimeError" RealtimeError: type: object + x-fern-sdk-group-name: realtime additionalProperties: false required: [error] properties: @@ -142,17 +145,21 @@ components: - { "error": "Client sent audio too fast" } MessageType: type: string + x-fern-sdk-group-name: realtime enum: [SessionBegins, PartialTranscript, FinalTranscript, SessionTerminated] RealtimeTranscriptType: type: string + x-fern-sdk-group-name: realtime enum: [PartialTranscript, FinalTranscript] RealtimeTranscript: + x-fern-sdk-group-name: realtime oneOf: - $ref: "#/components/schemas/PartialTranscript" - $ref: "#/components/schemas/FinalTranscript" discriminator: "message_type" SessionBegins: + x-fern-sdk-group-name: realtime allOf: - $ref: "#/components/schemas/RealtimeBaseMessage" - type: object @@ -182,6 +189,7 @@ components: message_type: "SessionBegins", } SessionTerminated: + x-fern-sdk-group-name: realtime allOf: - $ref: "#/components/schemas/RealtimeBaseMessage" - type: object @@ -197,6 +205,7 @@ components: - { message_type: "SessionTerminated" } RealtimeBaseTranscript: type: object + x-fern-sdk-group-name: realtime required: - audio_start - audio_end @@ -234,6 +243,7 @@ components: x-fern-type: datetime additionalProperties: false PartialTranscript: + x-fern-sdk-group-name: realtime allOf: - $ref: "#/components/schemas/RealtimeBaseTranscript" - type: object @@ -276,8 +286,8 @@ components: }, ], } - FinalTranscript: + x-fern-sdk-group-name: realtime allOf: - $ref: "#/components/schemas/RealtimeBaseTranscript" - type: object @@ -364,6 +374,7 @@ components: } Word: type: object + x-fern-sdk-group-name: realtime required: - start - end @@ -398,6 +409,7 @@ components: ] AudioData: type: object + x-fern-sdk-group-name: realtime required: - audio_data properties: @@ -408,6 +420,7 @@ components: examples: - { audio_data: "Je8w9JH1hfh1+7EAeQYJCC0JbQkxB70Apv0J/GT5APjA9jX1v/..." } TerminateSession: + x-fern-sdk-group-name: realtime allOf: - $ref: "#/components/schemas/RealtimeBaseMessage" - type: object diff --git a/fern/fern.config.json b/fern/fern.config.json index 44ec89f..a4122c1 100644 --- a/fern/fern.config.json +++ b/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "assemblyai", - "version": "0.15.0-rc74" -} \ No newline at end of file + "version": "0.16.1" +} diff --git a/fern/generators.yml b/fern/generators.yml index f62edd7..b2325d5 100644 --- a/fern/generators.yml +++ b/fern/generators.yml @@ -1,22 +1,22 @@ default-group: local -openapi: ../openapi.yml async-api: ../asyncapi.yml +openapi: ../openapi.yml groups: - local: - generators: + local: + generators: - name: fernapi/fern-typescript-node-sdk version: 0.7.4-rc0 output: location: npm url: npm.buildwithfern.com - package-name: '@assemblyai-fern/api' + package-name: "@assemblyai-fern/api" config: namespaceExport: AssemblyAI outputSourceFiles: true publish: generators: - name: fernapi/fern-java-sdk - version: 0.5.14 + version: 0.5.8-1-g8f19766 output: location: maven coordinate: com.assemblyai:assemblyai-java @@ -25,8 +25,8 @@ groups: github: repository: AssemblyAI/assemblyai-java-sdk mode: pull-request - config: + config: enable-forward-compatible-enums: true client-class-name: AssemblyAI - custom-dependencies: + custom-dependencies: - "implementation javax.websocket:javax.websocket-api:1.1" diff --git a/openapi.yml b/openapi.yml index f1e8585..c9be7c2 100644 --- a/openapi.yml +++ b/openapi.yml @@ -75,7 +75,8 @@ paths: summary: Create a transcript from an audio file operationId: createTranscript x-fern-sdk-group-name: transcripts - x-fern-sdk-method-name: create + x-fern-sdk-method-name: submit + x-fern-request-name: TranscriptParams description: Create a transcript from an audio or video file that is accessible via a URL. requestBody: description: Params to create a transcript @@ -112,6 +113,7 @@ paths: summary: List transcripts x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: list + x-fern-request-name: ListTranscriptParams operationId: listTranscripts description: Retrieve a list of transcripts you created parameters: @@ -124,7 +126,9 @@ paths: in: query description: Filter by transcript status schema: - $ref: "#/components/schemas/ListTranscriptParams/properties/status" + # Use TranscriptStatus instead of + # ListTranscriptParams/properties/limit for better SDK generation + $ref: "#/components/schemas/TranscriptStatus" - name: created_on in: query @@ -180,6 +184,7 @@ paths: operationId: getTranscript x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: get + x-fern-request-name: GetTranscriptParams description: Get the transcript resource. The transcript is ready when the "status" is "completed". parameters: - name: transcript_id @@ -255,6 +260,7 @@ paths: operationId: getSubtitles x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: getSubtitles + x-fern-request-name: GetSubtitlesParams description: Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions. parameters: - name: transcript_id @@ -313,6 +319,7 @@ paths: operationId: getTranscriptSentences x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: getSentences + x-fern-request-name: GetSentencesParams description: Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts. parameters: - name: transcript_id @@ -351,6 +358,7 @@ paths: operationId: getTranscriptParagraphs x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: getParagraphs + x-fern-request-name: GetParagraphsParams description: Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts. parameters: - name: transcript_id @@ -389,6 +397,7 @@ paths: operationId: wordSearch x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: wordSearch + x-fern-request-name: WordSearchParams description: Search through the transcript for a specific set of keywords. You can search for individual words, numbers, or phrases containing up to five words or numbers. parameters: - name: transcript_id @@ -437,6 +446,7 @@ paths: operationId: getRedactedAudio x-fern-sdk-group-name: transcripts x-fern-sdk-method-name: getRedactedAudio + x-fern-request-name: GetRedactedAudioParams parameters: - name: transcript_id in: path @@ -476,6 +486,7 @@ paths: operationId: createTemporaryToken x-fern-sdk-group-name: realtime x-fern-sdk-method-name: createTemporaryToken + x-fern-request-name: CreateRealtimeTemporaryTokenParams requestBody: description: Params to create a temporary authentication token required: true @@ -513,6 +524,7 @@ paths: operationId: lemurTask x-fern-sdk-group-name: lemur x-fern-sdk-method-name: task + x-fern-request-name: LemurTaskParams description: Use the LeMUR task endpoint to input your own LLM prompt. requestBody: description: Params to run the task @@ -551,6 +563,7 @@ paths: operationId: lemurSummary x-fern-sdk-group-name: lemur x-fern-sdk-method-name: summary + x-fern-request-name: LemurSummaryParams description: Custom Summary allows you to distill a piece of audio into a few impactful sentences. You can give the model context to obtain more targeted results while outputting the results in a variety of formats described in human language. requestBody: description: Params to generate the summary @@ -590,6 +603,7 @@ paths: operationId: lemurQuestionAnswer x-fern-sdk-group-name: lemur x-fern-sdk-method-name: questionAnswer + x-fern-request-name: LemurQuestionAnswerParams description: Question & Answer allows you to ask free-form questions about a single transcript or a group of transcripts. The questions can be any whose answers you find useful, such as judging whether a caller is likely to become a customer or whether all items on a meeting's agenda were covered. requestBody: description: Params to ask questions about the transcripts @@ -629,6 +643,7 @@ paths: operationId: lemurActionItems x-fern-sdk-group-name: lemur x-fern-sdk-method-name: actionItems + x-fern-request-name: LemurActionItemsParams description: Use LeMUR to generate a list of action items from a transcript requestBody: description: Params to generate action items from transcripts @@ -668,6 +683,7 @@ paths: operationId: purgeLemurRequestData x-fern-sdk-group-name: lemur x-fern-sdk-method-name: purgeRequestData + x-fern-request-name: PurgeLemurRequestDataParams description: | Delete the data for a previously submitted LeMUR request. The LLM response data, as well as any context provided in the original request will be removed. @@ -705,6 +721,7 @@ components: RedactedAudioResponse: type: object additionalProperties: false + x-fern-sdk-group-name: transcripts required: - status - redacted_audio_url @@ -723,12 +740,14 @@ components: RedactedAudioStatus: description: The status of the redacted audio + x-fern-sdk-group-name: transcripts type: string enum: - redacted_audio_ready SubtitleFormat: description: Format of the subtitles + x-fern-sdk-group-name: transcripts type: string enum: - srt @@ -736,6 +755,7 @@ components: WordSearchResponse: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false properties: id: @@ -786,6 +806,7 @@ components: WordSearchMatch: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false properties: text: @@ -827,6 +848,7 @@ components: WordSearchTimestamp: description: An array of timestamps structured as [`start_time`, `end_time`] in milliseconds + x-fern-sdk-group-name: transcripts type: array items: type: integer @@ -835,6 +857,7 @@ components: Timestamp: description: Timestamp containing a start and end property in milliseconds + x-fern-sdk-group-name: transcripts type: object additionalProperties: false properties: @@ -853,6 +876,7 @@ components: # This type is used by the Transcriber TranscriptOptionalParams: description: The parameters for creating a transcript + x-fern-sdk-group-name: transcripts type: object additionalProperties: false properties: @@ -1057,6 +1081,7 @@ components: TranscriptParams: description: The parameters for creating a transcript + x-fern-sdk-group-name: transcripts type: object additionalProperties: false allOf: @@ -1109,6 +1134,7 @@ components: SummaryModel: type: string description: The model to summarize the transcript + x-fern-sdk-group-name: transcripts default: informative enum: - informative @@ -1118,6 +1144,7 @@ components: SummaryType: type: string description: The type of summary + x-fern-sdk-group-name: transcripts default: bullets enum: - bullets @@ -1129,6 +1156,7 @@ components: TranscriptBoostParam: type: string description: The word boost parameter value + x-fern-sdk-group-name: transcripts enum: - low - default @@ -1136,6 +1164,7 @@ components: TranscriptCustomSpelling: description: Object containing words or phrases to replace, and the word or phrase to replace with + x-fern-sdk-group-name: transcripts type: object additionalProperties: false properties: @@ -1154,6 +1183,7 @@ components: TranscriptUtterance: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false properties: confidence: @@ -1305,6 +1335,7 @@ components: SubstitutionPolicy: type: string + x-fern-sdk-group-name: transcripts description: The replacement logic for detected PII, can be "entity_type" or "hash". See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details. enum: - entity_type @@ -1312,6 +1343,7 @@ components: PiiPolicy: type: string + x-fern-sdk-group-name: transcripts enum: - medical_process - medical_condition @@ -1346,6 +1378,7 @@ components: description: | The language of your audio file. Possible values are found in [Supported Languages](https://www.assemblyai.com/docs/concepts/supported-languages). The default value is 'en_us'. + x-fern-sdk-group-name: transcripts default: en_us enum: - en @@ -1372,6 +1405,7 @@ components: TranscriptStatus: type: string description: The status of your transcript. Possible values are queued, processing, completed, or error. + x-fern-sdk-group-name: transcripts enum: - queued - processing @@ -1390,6 +1424,7 @@ components: Transcript: description: A transcript object type: object + x-fern-sdk-group-name: transcripts additionalProperties: false properties: id: @@ -2268,6 +2303,7 @@ components: description: | The result of the Topic Detection model, if it is enabled. See [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection) for more information. + x-fern-sdk-group-name: transcripts type: object required: - status @@ -2368,11 +2404,11 @@ components: }, } - ContentSafetyLabelsResult: description: | An array of results for the Content Moderation model, if it is enabled. See [Content moderation](https://www.assemblyai.com/docs/models/content-moderation) for more information. + x-fern-sdk-group-name: transcripts type: object required: - status @@ -2438,6 +2474,7 @@ components: Chapter: description: Chapter of the audio file + x-fern-sdk-group-name: transcripts type: object additionalProperties: false required: @@ -2473,6 +2510,7 @@ components: Entity: description: A detected entity + x-fern-sdk-group-name: transcripts type: object additionalProperties: false required: @@ -2498,6 +2536,7 @@ components: EntityType: description: The type of entity for the detected entity + x-fern-sdk-group-name: transcripts type: string enum: - banking_information @@ -2594,6 +2633,7 @@ components: SentimentAnalysisResult: description: The result of the sentiment analysis model + x-fern-sdk-group-name: transcripts type: object additionalProperties: false required: @@ -2635,6 +2675,7 @@ components: } Sentiment: + x-fern-sdk-group-name: transcripts enum: - POSITIVE - NEUTRAL @@ -2642,6 +2683,7 @@ components: TopicDetectionResult: description: The result of the topic detection model + x-fern-sdk-group-name: transcripts type: object additionalProperties: false required: @@ -2715,6 +2757,7 @@ components: ContentSafetyLabel: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - label @@ -2745,6 +2788,7 @@ components: ContentSafetyLabelResult: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - text @@ -2788,6 +2832,7 @@ components: SeverityScoreSummary: type: object + x-fern-sdk-group-name: transcripts required: - low - medium @@ -2815,6 +2860,7 @@ components: description: | An array of results for the Key Phrases model, if it is enabled. See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information. + x-fern-sdk-group-name: transcripts type: object required: - results @@ -2941,6 +2987,7 @@ components: AutoHighlightResult: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - count @@ -2975,6 +3022,7 @@ components: TranscriptWord: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - confidence @@ -3001,6 +3049,7 @@ components: TranscriptSentence: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - text @@ -3063,6 +3112,7 @@ components: SentencesResponse: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - id @@ -3186,6 +3236,7 @@ components: TranscriptParagraph: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - text @@ -3241,6 +3292,7 @@ components: ParagraphsResponse: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - id @@ -3341,6 +3393,7 @@ components: PageDetails: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - limit @@ -3369,6 +3422,9 @@ components: ListTranscriptParams: type: object + x-fern-sdk-group-name: transcripts + # Don't use this type in Fern SDKs as it is already generated from the endpoint parameters + x-fern-ignore: true additionalProperties: false properties: limit: @@ -3408,6 +3464,7 @@ components: TranscriptListItem: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - id @@ -3445,6 +3502,7 @@ components: TranscriptList: type: object + x-fern-sdk-group-name: transcripts additionalProperties: false required: - page_details @@ -3489,6 +3547,7 @@ components: UploadedFile: type: object + x-fern-sdk-group-name: files additionalProperties: false required: - upload_url @@ -3503,6 +3562,7 @@ components: CreateRealtimeTemporaryTokenParams: type: object + x-fern-sdk-group-name: realtime additionalProperties: false properties: expires_in: @@ -3515,6 +3575,7 @@ components: RealtimeTemporaryTokenResponse: type: object + x-fern-sdk-group-name: realtime additionalProperties: false required: - token @@ -3528,6 +3589,7 @@ components: } AudioIntelligenceModelStatus: + x-fern-sdk-group-name: transcripts type: string description: Either success, or unavailable in the rare case that the model failed enum: @@ -3535,6 +3597,7 @@ components: - unavailable PurgeLemurRequestDataResponse: + x-fern-sdk-group-name: lemur type: object additionalProperties: false properties: @@ -3562,6 +3625,7 @@ components: # This is to have a type that can be used to get the ID so it can be deleted LemurBaseResponse: + x-fern-sdk-group-name: lemur type: object additionalProperties: false properties: @@ -3574,6 +3638,7 @@ components: { request_id: "5e1b27c2-691f-4414-8bc5-f14678442f9e" } LemurSummaryResponse: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseResponse" - type: object @@ -3597,6 +3662,7 @@ components: - Climate change is leading to longer and more severe fire seasons. Events of smoke traveling long distances and affecting air quality over wide areas will likely become more common in the future." LemurQuestionAnswerResponse: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseResponse" - type: object @@ -3619,6 +3685,7 @@ components: } LemurQuestionAnswer: + x-fern-sdk-group-name: lemur type: object description: An answer generated by LeMUR and its question additionalProperties: false @@ -3634,6 +3701,7 @@ components: { answer: "CA, US", question: "Where are there wildfires?" } LemurActionItemsResponse: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseResponse" - type: object @@ -3667,6 +3735,7 @@ components: - Develop strategies to prevent and manage wildfires to limit air quality impacts. LemurTaskResponse: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseResponse" - type: object @@ -3690,6 +3759,7 @@ components: - Baltimore LemurBaseParams: + x-fern-sdk-group-name: lemur type: object additionalProperties: false properties: @@ -3735,6 +3805,7 @@ components: } LemurTaskParams: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseParams" - type: object @@ -3755,6 +3826,7 @@ components: } LemurSummaryParams: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseParams" - type: object @@ -3774,6 +3846,7 @@ components: } LemurQuestionAnswerParams: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseParams" - type: object @@ -3807,6 +3880,7 @@ components: } LemurQuestion: + x-fern-sdk-group-name: lemur type: object additionalProperties: false required: [question] @@ -3837,6 +3911,7 @@ components: } LemurActionItemsParams: + x-fern-sdk-group-name: lemur allOf: - $ref: "#/components/schemas/LemurBaseParams" example: @@ -3849,6 +3924,7 @@ components: } LemurModel: + x-fern-sdk-group-name: lemur type: string description: | The model that is used for the final prompt after compression is performed (options: "basic" and "default").