Type Alias AssistantsAPI

type AssistantsAPI = {
    clearCache: typeof clearCache;
    createAssistant: typeof createAssistant;
    createAssistantStarter: typeof createAssistantStarter;
    createAssistantThread: typeof createAssistantThread;
    createAssistantThreadInteraction: typeof createAssistantThreadInteraction;
    createAssistantThreadInteractionFeedback: typeof createAssistantThreadInteractionFeedback;
    createAssistantThreadInteractionReview: typeof createAssistantThreadInteractionReview;
    deleteAssistant: typeof deleteAssistant;
    deleteAssistantStarter: typeof deleteAssistantStarter;
    deleteAssistantStarterFollowup: typeof deleteAssistantStarterFollowup;
    deleteAssistantThread: typeof deleteAssistantThread;
    deleteAssistantThreadInteraction: typeof deleteAssistantThreadInteraction;
    getAssistant: typeof getAssistant;
    getAssistantFeedback: typeof getAssistantFeedback;
    getAssistants: typeof getAssistants;
    getAssistantSources: typeof getAssistantSources;
    getAssistantStarter: typeof getAssistantStarter;
    getAssistantStarters: typeof getAssistantStarters;
    getAssistantThread: typeof getAssistantThread;
    getAssistantThreadInteraction: typeof getAssistantThreadInteraction;
    getAssistantThreadInteractions: typeof getAssistantThreadInteractions;
    getAssistantThreads: typeof getAssistantThreads;
    invokeAssistantThread: typeof invokeAssistantThread;
    patchAssistant: typeof patchAssistant;
    patchAssistantThread: typeof patchAssistantThread;
    patchAssistantThreadInteractionFeedback: typeof patchAssistantThreadInteractionFeedback;
    streamAssistantThread: typeof streamAssistantThread;
    updateAssistantStarter: typeof updateAssistantStarter;
    updateAssistantStarterFollowup: typeof updateAssistantStarterFollowup;
}
Index

Properties

clearCache createAssistant createAssistantStarter createAssistantThread createAssistantThreadInteraction createAssistantThreadInteractionFeedback createAssistantThreadInteractionReview deleteAssistant deleteAssistantStarter deleteAssistantStarterFollowup deleteAssistantThread deleteAssistantThreadInteraction getAssistant getAssistantFeedback getAssistants getAssistantSources getAssistantStarter getAssistantStarters getAssistantThread getAssistantThreadInteraction getAssistantThreadInteractions getAssistantThreads invokeAssistantThread patchAssistant patchAssistantThread patchAssistantThreadInteractionFeedback streamAssistantThread updateAssistantStarter updateAssistantStarterFollowup

Properties

clearCache: typeof clearCache

Clears the cache for assistants api requests.

createAssistant: typeof createAssistant

Creates a new assistant.

Param: body

an object with the body content

CreateAssistantHttpError

createAssistantStarter: typeof createAssistantStarter

Creates a new starter for the assistant.

The ID of the assistant in which to create the starter.

Param: body

an object with the body content

CreateAssistantStarterHttpError

createAssistantThread: typeof createAssistantThread

Creates a new thread for the assistant.

The ID of the assistant in which to create the thread.

Param: body

an object with the body content

CreateAssistantThreadHttpError

createAssistantThreadInteraction: typeof createAssistantThreadInteraction

Creates a new interaction for the thread.

The ID of the assistant in which to create the interaction.

The ID of the thread in which to create the interaction.

Param: body

an object with the body content

CreateAssistantThreadInteractionHttpError

createAssistantThreadInteractionFeedback: typeof createAssistantThreadInteractionFeedback

Creates feedback for the thread.

The ID of the assistant in which to create the feedback.

The ID of the thread in which to create the feedback.

The ID of the interaction in which to create the feedback.

Param: body

an object with the body content

CreateAssistantThreadInteractionFeedbackHttpError

createAssistantThreadInteractionReview: typeof createAssistantThreadInteractionReview

Creates feedback review for the thread.

The ID of the assistant in which to create the feedback review.

The ID of the thread in which to create the feedback review.

The ID of the interaction in which to create the feedback review.

Param: body

an object with the body content

CreateAssistantThreadInteractionReviewHttpError

deleteAssistant: typeof deleteAssistant

Deletes the assistant and all of its resources.

The ID of the assistant to delete.

DeleteAssistantHttpError

deleteAssistantStarter: typeof deleteAssistantStarter

Deletes the starter and all of its resources.

The ID of the assistant containing the requested starter.

The ID of the starter to delete.

DeleteAssistantStarterHttpError

deleteAssistantStarterFollowup: typeof deleteAssistantStarterFollowup

Deletes the specified Followup.

The ID of the assistant containing the requested Followup.

The ID of the starter containing the requested Followup.

The ID of the Followup to delete.

DeleteAssistantStarterFollowupHttpError

deleteAssistantThread: typeof deleteAssistantThread

Deletes the specified thread and all of its resources.

The ID of the assistant containing the requested thread.

The ID of the thread to retrieve.

DeleteAssistantThreadHttpError

deleteAssistantThreadInteraction: typeof deleteAssistantThreadInteraction

Deletes the specified interaction and all of its resources.

The ID of the assistant in which to delete the interaction.

The ID of the thread in which to delete the interaction.

The ID of the interaction to delete.

DeleteAssistantThreadInteractionHttpError

getAssistant: typeof getAssistant

Retrieves the specified assistant.

The ID of the assistant to retrieve.

GetAssistantHttpError

getAssistantFeedback: typeof getAssistantFeedback

Retrieves feedback summary for the assistant.

The ID of the assistant from which to retrieve feedback summary.

GetAssistantFeedbackHttpError

getAssistants: typeof getAssistants

Retrieves the list of assistants. The result can be filtered, sorted, and paginated.

an object with query parameters

GetAssistantsHttpError

getAssistantSources: typeof getAssistantSources

Perform a bulk search for the plaintext of source chunks for the assistant.

The ID of the assistant in which to search for source chunks.

Param: body

an object with the body content

GetAssistantSourcesHttpError

getAssistantStarter: typeof getAssistantStarter

Retrieves the specified starter.

The ID of the assistant containing the requested starter.

The ID of the starter to retrieve.

GetAssistantStarterHttpError

getAssistantStarters: typeof getAssistantStarters

Retrieves the list of starters for the assistant.

The ID of the assistant from which to retrieve starters.

an object with query parameters

GetAssistantStartersHttpError

getAssistantThread: typeof getAssistantThread

Retrieves a thread for the assistant.

The ID of the assistant containing the requested thread.

The ID of the thread to retrieve.

GetAssistantThreadHttpError

getAssistantThreadInteraction: typeof getAssistantThreadInteraction

Retrieves an interaction for the thread.

The ID of the assistant in which to retrieve the interaction.

The ID of the thread in which to retrieve the interaction.

The ID of the interaction to retrieve.

GetAssistantThreadInteractionHttpError

getAssistantThreadInteractions: typeof getAssistantThreadInteractions

Retrieves the list of interactions for the thread.

The ID of the assistant from which to retrieve the interactions.

The ID of the thread from which to retrieve the interactions.

an object with query parameters

GetAssistantThreadInteractionsHttpError

getAssistantThreads: typeof getAssistantThreads

Retrieves the list of threads for the assistant.

The ID of the assistant from which to retrieve threads.

an object with query parameters

GetAssistantThreadsHttpError

invokeAssistantThread: typeof invokeAssistantThread

Execute prompt in synchronous non-streaming mode.

The id of the Assistant containing requested Thread

The id of the Thread to retrieve

Param: body

an object with the body content

InvokeAssistantThreadHttpError

patchAssistant: typeof patchAssistant

Updates the properties of an existing assistant with JSON Patch-formatted data.

The assistant ID.

Param: body

an object with the body content

PatchAssistantHttpError

patchAssistantThread: typeof patchAssistantThread

Updates the properties of an existing thread with JSON Patch-formatted data.

The ID of the assistant containing the requested thread.

The ID of the thread to retrieve.

Param: body

an object with the body content

PatchAssistantThreadHttpError

patchAssistantThreadInteractionFeedback: typeof patchAssistantThreadInteractionFeedback

Updates feedback for the thread.

The ID of the assistant containing the requested feedback.

The ID of the thread containing the requested feedback.

The ID of the interaction containing the requested Feedback.

The ID of the feedback to update.

Param: body

an object with the body content

PatchAssistantThreadInteractionFeedbackHttpError

streamAssistantThread: typeof streamAssistantThread

Execute prompt in asynchronous streaming mode.

The id of the Assistant containing requested Thread

The id of the Thread to retrieve

Param: body

an object with the body content

StreamAssistantThreadHttpError

updateAssistantStarter: typeof updateAssistantStarter

Updates the specified starter.

The ID of the assistant containing the requested starter.

The ID of the starter to retrieve.

Param: body

an object with the body content

UpdateAssistantStarterHttpError

updateAssistantStarterFollowup: typeof updateAssistantStarterFollowup

Updates the specified Followup.

The ID of the assistant containing the requested Followup.

The ID of the starter containing the requested Followup.

The ID of the Followup to update.

Param: body

an object with the body content

UpdateAssistantStarterFollowupHttpError

Settings

Member Visibility

On This Page

Properties