diff --git a/openapi.yml b/openapi.yml index 7b35e24..92b3d58 100644 --- a/openapi.yml +++ b/openapi.yml @@ -1,4 +1,5 @@ openapi: 3.1.0 + info: title: AssemblyAI API description: AssemblyAI API @@ -82,7 +83,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CreateTranscriptParameters" + $ref: "#/components/schemas/TranscriptParams" responses: "201": description: Transcript created and queued for processing @@ -118,36 +119,36 @@ paths: in: query description: Maximum amount of transcripts to retrieve schema: - $ref: "#/components/schemas/TranscriptListParameters/properties/limit" + $ref: "#/components/schemas/ListTranscriptParams/properties/limit" - name: status in: query description: Filter by transcript status schema: - $ref: "#/components/schemas/TranscriptListParameters/properties/status" + $ref: "#/components/schemas/ListTranscriptParams/properties/status" - name: created_on in: query description: Only get transcripts created on this date schema: - $ref: "#/components/schemas/TranscriptListParameters/properties/created_on" + $ref: "#/components/schemas/ListTranscriptParams/properties/created_on" - name: before_id in: query description: Get transcripts that were created before this transcript ID schema: - $ref: "#/components/schemas/TranscriptListParameters/properties/before_id" + $ref: "#/components/schemas/ListTranscriptParams/properties/before_id" - name: after_id in: query description: Get transcripts that were created after this transcript ID schema: - $ref: "#/components/schemas/TranscriptListParameters/properties/after_id" + $ref: "#/components/schemas/ListTranscriptParams/properties/after_id" - name: throttled_only in: query description: Only get throttled transcripts, overrides the status filter schema: - $ref: "#/components/schemas/TranscriptListParameters/properties/throttled_only" + $ref: "#/components/schemas/ListTranscriptParams/properties/throttled_only" responses: "200": @@ -481,7 +482,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CreateRealtimeTemporaryTokenParameters" + $ref: "#/components/schemas/CreateRealtimeTemporaryTokenParams" responses: "200": description: Temporary authentication token generated @@ -504,30 +505,29 @@ paths: "504": $ref: "#/components/responses/GatewayTimeout" - /lemur/v3/generate/summary: + /lemur/v3/generate/task: post: tags: - LeMUR - summary: Generate a custom summary from one or more transcripts - operationId: lemurSummary + summary: Run a LLM task with your own prompt + operationId: lemurTask x-fern-sdk-group-name: lemur - x-fern-sdk-method-name: summary - 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. + x-fern-sdk-method-name: task + description: Use the LeMUR task endpoint to input your own LLM prompt. requestBody: - description: Parameters to generate the summary + description: Parameters to run the task required: true content: application/json: schema: - $ref: "#/components/schemas/LemurSummaryParameters" - + $ref: "#/components/schemas/LemurTaskParams" responses: "200": - description: LeMUR summary response + description: LeMUR task response content: application/json: schema: - $ref: "#/components/schemas/LemurSummaryResponse" + $ref: "#/components/schemas/LemurTaskResponse" "400": $ref: "#/components/responses/BadRequest" "401": @@ -543,30 +543,30 @@ paths: "504": $ref: "#/components/responses/GatewayTimeout" - /lemur/v3/generate/question-answer: + /lemur/v3/generate/summary: post: tags: - LeMUR - summary: Create answers to one or more questions about one or more transcripts - operationId: lemurQuestionAnswer + summary: Generate a custom summary from one or more transcripts + operationId: lemurSummary x-fern-sdk-group-name: lemur - x-fern-sdk-method-name: questionAnswer - 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. + x-fern-sdk-method-name: summary + 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: Parameters to ask questions about the transcripts + description: Parameters to generate the summary required: true content: application/json: schema: - $ref: "#/components/schemas/LemurQuestionAnswerParameters" + $ref: "#/components/schemas/LemurSummaryParams" responses: "200": - description: LeMUR question & answer response + description: LeMUR summary response content: application/json: schema: - $ref: "#/components/schemas/LemurQuestionAnswerResponse" + $ref: "#/components/schemas/LemurSummaryResponse" "400": $ref: "#/components/responses/BadRequest" "401": @@ -582,30 +582,30 @@ paths: "504": $ref: "#/components/responses/GatewayTimeout" - /lemur/v3/generate/action-items: + /lemur/v3/generate/question-answer: post: tags: - LeMUR - summary: Extract action items from one or more meeting transcripts - operationId: lemurActionItems + summary: Create answers to one or more questions about one or more transcripts + operationId: lemurQuestionAnswer x-fern-sdk-group-name: lemur - x-fern-sdk-method-name: actionItems - description: Use LeMUR to generate a list of Action Items from a transcript + x-fern-sdk-method-name: questionAnswer + 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: Parameters to generate action items from transcripts + description: Parameters to ask questions about the transcripts required: true content: application/json: schema: - $ref: "#/components/schemas/LemurActionItemsParameters" + $ref: "#/components/schemas/LemurQuestionAnswerParams" responses: "200": - description: LeMUR action items response + description: LeMUR question & answer response content: application/json: schema: - $ref: "#/components/schemas/LemurActionItemsResponse" + $ref: "#/components/schemas/LemurQuestionAnswerResponse" "400": $ref: "#/components/responses/BadRequest" "401": @@ -621,30 +621,30 @@ paths: "504": $ref: "#/components/responses/GatewayTimeout" - /lemur/v3/generate/task: + /lemur/v3/generate/action-items: post: tags: - LeMUR - summary: Use your own prompt to run a Custom Task - operationId: lemurTask + summary: Extract action items from one or more meeting transcripts + operationId: lemurActionItems x-fern-sdk-group-name: lemur - x-fern-sdk-method-name: task - description: Use your own prompt to run a Custom Task to handle your specialized task. + x-fern-sdk-method-name: actionItems + description: Use LeMUR to generate a list of action items from a transcript requestBody: - description: Parameters to run the custom task + description: Parameters to generate action items from transcripts required: true content: application/json: schema: - $ref: "#/components/schemas/LemurTaskParameters" + $ref: "#/components/schemas/LemurActionItemsParams" responses: "200": - description: LeMUR task response + description: LeMUR action items response content: application/json: schema: - $ref: "#/components/schemas/LemurTaskResponse" + $ref: "#/components/schemas/LemurActionItemsResponse" "400": $ref: "#/components/responses/BadRequest" "401": @@ -797,7 +797,7 @@ components: - end # This type is used by the Transcriber - CreateTranscriptOptionalParameters: + TranscriptOptionalParams: description: The parameters for creating a transcript type: object additionalProperties: false @@ -965,12 +965,12 @@ components: items: type: string - CreateTranscriptParameters: + TranscriptParams: description: The parameters for creating a transcript type: object additionalProperties: false allOf: - - $ref: "#/components/schemas/CreateTranscriptOptionalParameters" + - $ref: "#/components/schemas/TranscriptOptionalParams" - type: object required: [audio_url] properties: @@ -1971,7 +1971,7 @@ components: next_url: type: [string, "null"] - TranscriptListParameters: + ListTranscriptParams: type: object additionalProperties: false properties: @@ -2050,7 +2050,7 @@ components: description: A URL that points to your audio file, accessible only by AssemblyAI's servers type: string - CreateRealtimeTemporaryTokenParameters: + CreateRealtimeTemporaryTokenParams: type: object additionalProperties: false properties: @@ -2105,6 +2105,17 @@ components: type: string required: [request_id] + LemurTaskResponse: + allOf: + - $ref: "#/components/schemas/LemurBaseResponse" + - type: object + additionalProperties: false + properties: + response: + description: The response generated by LeMUR + type: string + required: [response] + LemurSummaryResponse: allOf: - $ref: "#/components/schemas/LemurBaseResponse" @@ -2153,18 +2164,7 @@ components: type: string required: [response] - LemurTaskResponse: - allOf: - - $ref: "#/components/schemas/LemurBaseResponse" - - type: object - additionalProperties: false - properties: - response: - description: The response generated by LeMUR - type: string - required: [response] - - LemurBaseParameters: + LemurBaseParams: type: object additionalProperties: false properties: @@ -2201,9 +2201,20 @@ components: minimum: 0 maximum: 1 - LemurSummaryParameters: + LemurTaskParams: + allOf: + - $ref: "#/components/schemas/LemurBaseParams" + - type: object + additionalProperties: false + properties: + prompt: + description: Your text to prompt the model to produce a desired output, including any context you want to pass into the model. + type: string + required: [prompt] + + LemurSummaryParams: allOf: - - $ref: "#/components/schemas/LemurBaseParameters" + - $ref: "#/components/schemas/LemurBaseParams" - type: object additionalProperties: false properties: @@ -2212,9 +2223,9 @@ components: How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points" type: string - LemurQuestionAnswerParameters: + LemurQuestionAnswerParams: allOf: - - $ref: "#/components/schemas/LemurBaseParameters" + - $ref: "#/components/schemas/LemurBaseParams" - type: object additionalProperties: false properties: @@ -2250,20 +2261,9 @@ components: items: type: string - LemurActionItemsParameters: + LemurActionItemsParams: allOf: - - $ref: "#/components/schemas/LemurBaseParameters" - - LemurTaskParameters: - allOf: - - $ref: "#/components/schemas/LemurBaseParameters" - - type: object - additionalProperties: false - properties: - prompt: - description: Your text to prompt the model to produce a desired output, including any context you want to pass into the model. - type: string - required: [prompt] + - $ref: "#/components/schemas/LemurBaseParams" LemurModel: type: string