Sign in
llm

Start LlmAssistant job

post/llm/llm_assistant

Request body

project_idinteger required

Project ID associated with the job

llm_job_type'TAGGING' | 'METADATA_EXTRACTION' | 'ANNOTATION' | 'SENTENCE_ANNOTATION' required
llm_approach_type'LLM_ZERO_SHOT' | 'LLM_FEW_SHOT' required

Response

Successful Response

job_idstring required

RQ job ID

job_typestring required

Type of the job

project_idinteger required

Project ID associated with the job

status'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required
status_messagestring nullable

Status message

current_stepinteger required

Current step in the job process

stepsstring[] required

Total number of steps in the job process

createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job

Changes

Changed in 6 of the 73 revisions of this API.71120

  • 6fbeab15ac3742See the full diff
    • ●

      added the new partial enum value to the output/anyOf[subschema #1: LLMJobOutput]/specific_task_result/oneOf[subschema #1: TaggingLLMJobResult]/results/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new partial enum value to the output/anyOf[subschema #1: LLMJobOutput]/specific_task_result/oneOf[subschema #2: MetadataExtractionLLMJobResult]/results/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new partial enum value to the output/anyOf[subschema #1: LLMJobOutput]/specific_task_result/oneOf[subschema #3: AnnotationLLMJobResult]/results/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new partial enum value to the output/anyOf[subschema #1: LLMJobOutput]/specific_task_result/oneOf[subschema #4: SentenceAnnotationLLMJobResult]/results/items/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property output/anyOf[subschema #1: LLMJobOutput]/specific_task_result/oneOf[subschema #3: AnnotationLLMJobResult]/results/items/raw_response to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property output/anyOf[subschema #1: LLMJobOutput]/specific_task_result/oneOf[subschema #4: SentenceAnnotationLLMJobResult]/results/items/raw_response to the response with the 200 status

      response-optional-property-added

  • 1af5a8046f202See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ea28bda836c522See the full diff
    • ▲

      added the new required request property specific_approach_parameters/oneOf[subschema #1: ZeroShotParams]/model

      new-required-request-property

    • ▲

      added the new required request property specific_approach_parameters/oneOf[subschema #2: FewShotParams]/model

      new-required-request-property

    • ○

      added the required property input/specific_approach_parameters/oneOf[subschema #1: ZeroShotParams]/model to the response with the 200 status

      response-required-property-added

    • ○

      added the required property input/specific_approach_parameters/oneOf[subschema #2: FewShotParams]/model to the response with the 200 status

      response-required-property-added

  • ab1f53e958b74See the full diff
    • ○

      added the new optional request property specific_task_parameters/oneOf[subschema #3: AnnotationParams]/delete_existing_annotations

      new-optional-request-property

    • ○

      the delete_existing_annotations request property default value changed from true to false

      request-property-default-value-changed

    • ○

      added the optional property input/specific_task_parameters/oneOf[subschema #3: AnnotationParams]/delete_existing_annotations to the response with the 200 status

      response-optional-property-added

    • ○

      the delete_existing_annotations response's property default value changed from true to false for the status 200

      response-property-default-value-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d59c807fb98524See the full diff
    • ▲

      removed the enum value MODEL_TRAINING of the request property llm_approach_type

      request-property-enum-value-removed

    • ▲

      removed ModelTrainingParams from the specific_approach_parameters request property oneOf list

      request-property-one-of-removed

    • ○

      removed MODEL_TRAINING discriminator mapping keys from the specific_approach_parameters request property

      request-property-discriminator-mapping-deleted

    • ○

      removed MODEL_TRAINING discriminator mapping keys from the input/specific_approach_parameters response property for the response status 200

      response-property-discriminator-mapping-deleted

    • ○

      removed the MODEL_TRAINING enum value from the input/llm_approach_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed ModelTrainingParams from the input/specific_approach_parameters response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 53e769440a25376See the full diff
    • ▲

      added ModelTrainingParams to the input/specific_approach_parameters response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      removed the required property input/specific_approach_parameters/oneOf[subschema #1: ZeroShotParams]/model from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property input/specific_approach_parameters/oneOf[subschema #2: FewShotParams]/model from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property specific_approach_parameters/oneOf[subschema #1: ZeroShotParams]/model

      request-property-removed

    • ●

      removed the request property specific_approach_parameters/oneOf[subschema #2: FewShotParams]/model

      request-property-removed

    • ●

      removed the request property specific_task_parameters/oneOf[subschema #3: AnnotationParams]/delete_existing_annotations

      request-property-removed

    • ●

      removed the optional property detail/items/ctx from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property detail/items/input from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property input/specific_task_parameters/oneOf[subschema #3: AnnotationParams]/delete_existing_annotations from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new MODEL_TRAINING enum value to the input/llm_approach_type response property for the response status 200

      response-property-enum-value-added

    • ○

      the delete_existing_annotations request property default value changed from false to true

      request-property-default-value-changed

    • ○

      added MODEL_TRAINING discriminator mapping keys to the specific_approach_parameters request property

      request-property-discriminator-mapping-added

    • ○

      added the new MODEL_TRAINING enum value to the request property llm_approach_type

      request-property-enum-value-added

    • ○

      added ModelTrainingParams to the specific_approach_parameters request property oneOf list

      request-property-one-of-added

    • ○

      the delete_existing_annotations response's property default value changed from false to true for the status 200

      response-property-default-value-changed

    • ○

      added MODEL_TRAINING discriminator mapping keys to the input/specific_approach_parameters response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog