nostaigia/ParaTool huggingface dataset:
name: Buses_3_FindBus
description: Search for a bus itinerary between two cities on a specific date.
parameters: type: dict
required: from_city
to_city
departure_date
properties: from_city: type: string
description: The city of departure, in the format of 'City, State', such as 'Berkeley, CA'.
to_city: type: string
description: The destination city of the trip, in the format of 'City, State', such as 'Los Angeles, CA'.
departure_date: type: string
description: The date of departure in the format of 'YYYY-MM-DD', such as '2023-04-15'.
num_passengers: type: integer
description: The number of passengers for the trip.
enum: 1
2
3
4
5
default: 1
category: type: string
description: The category of the trip based on the number of stops.
enum: direct
one-stop
default: direct
name: Buses_3_BuyBusTicket
description: Purchase bus tickets for a specified route, date, and time. Options for the number of passengers and additional luggage are available.
parameters: type: dict
required: from_city
to_city
departure_date
departure_time
properties: from_city: type: string
description: The city to depart from, such as 'New York, NY'.
to_city: type: string
description: The destination city of the trip, such as 'Boston, MA'.
departure_date: type: string
description: The date of departure, in the format of 'YYYY-MM-DD'.
departure_time: type: string
description: The time of departure, in 24-hour format 'HH:MM'.
num_passengers: type: integer
description: The number of tickets for the trip.
enum: 1
2
3
4
5
default: 1
additional_luggage: type: boolean
description: An option to carry excess baggage in the bus.
default: no
name: Events_3_FindEvents
description: Find cultural events, such as concerts and plays, happening in a specified city and optionally on a specific date.
parameters: type: dict
required: event_type
city
properties: event_type: type: string
description: The type of cultural event to find. Possible values are 'Music' for concerts and 'Theater' for plays.
enum: Music
Theater
city: type: string
description: The city where the event is taking place, in the format of 'City, State' (e.g., 'New York, NY').
date: type: string
description: The date of the event in the format 'YYYY-MM-DD'. If not specified, the function will search for events regardless of date.
name: Events_3_BuyEventTickets
description: Facilitates the purchase of tickets for a cultural event on a specific date in a designated city.
parameters: type: dict
required: event_name
number_of_tickets
date
properties: event_name: type: string
description: The name of the artist or the title of the play for which tickets are being purchased.
number_of_tickets: type: integer
description: The quantity of tickets to be reserved for the event.
date: type: string
description: The scheduled date of the event, in the format 'YYYY-MM-DD'.
city: type: string
description: The city where the event is located, in the format of 'City, State', such as 'Berkeley, CA' and 'New York, NY'.
name: Buses_3_FindBus
description: Search for a bus itinerary between two cities on a specific date.
parameters: type: dict
required: from_city
to_city
departure_date
properties: from_city: type: string
description: The city of departure, in the format of 'City, State', such as 'Berkeley, CA'.
to_city: type: string
description: The destination city of the trip, in the format of 'City, State', such as 'Los Angeles, CA'.
departure_date: type: string
description: The date of departure in the format of 'YYYY-MM-DD', such as '2023-04-15'.
num_passengers: type: integer
description: The number of passengers for the trip.
enum: 1
2
3
4
5
default: 1
category: type: string
description: The category of the trip based on the number of stops.
enum: direct
one-stop
default: direct
name: Buses_3_BuyBusTicket
description: Purchase bus tickets for a specified route, date, and time. Options for the number of passengers and additional luggage are available.
parameters: type: dict
required: from_city
to_city
departure_date
departure_time
properties: from_city: type: string
description: The city to depart from, such as 'New York, NY'.
to_city: type: string
description: The destination city of the trip, such as 'Boston, MA'.
departure_date: type: string
description: The date of departure, in the format of 'YYYY-MM-DD'.
departure_time: type: string
description: The time of departure, in 24-hour format 'HH:MM'.
num_passengers: type: integer
description: The number of tickets for the trip.
enum: 1
2
3
4
5
default: 1
additional_luggage: type: boolean
description: An option to carry excess baggage in the bus.
default: no
name: Events_3_FindEvents
description: Find cultural events, such as concerts and plays, happening in a specified city and optionally on a specific date.
parameters: type: dict
required: event_type
city
properties: event_type: type: string
description: The type of cultural event to find. Possible values are 'Music' for concerts and 'Theater' for plays.
enum: Music
Theater
city: type: string
description: The city where the event is taking place, in the format of 'City, State', with state using the abbreviated name (e.g., 'New York, NY').
date: type: string
description: The date of the event in the format 'YYYY-MM-DD'. If not specified, the function will search for events regardless of date.
name: Events_3_BuyEventTickets
description: Facilitates the purchase of tickets for a cultural event on a specific date in a designated city.
parameters: type: dict
required: event_name
number_of_tickets
date
properties: event_name: type: string
description: The name of the artist or the title of the play for which tickets are being purchased.
number_of_tickets: type: integer
description: The quantity of tickets to be reserved for the event.
date: type: string
description: The scheduled date of the event, in the format 'YYYY-MM-DD'.
city: type: string
description: The city where the event is located, in the format of 'City, State', such as 'Berkeley, CA' and 'New York, NY'.
name: Music_3_PlayMedia
description: Plays the specified track on the designated device, optionally filtering by artist and album.
parameters: type: dict
required: track
properties: track: type: string
description: The title of the track to be played.
artist: type: string
description: The name of the artist performing the track. If not specified, any artist is considered acceptable.
default: any
device: type: string
description: The designated media player device where the music will be played.
enum: Living room
Kitchen
Patio
default: Living room
album: type: string
description: The album where the track is from. If not specified, tracks from any album are considered.
default: any
name: Music_3_LookupMusic
description: Retrieve a list of songs that align with the user's musical preferences based on the specified artist, album, genre, and release year.
parameters: type: dict
properties: artist: type: string
description: The first and last name of the performer. Use 'dontcare' to ignore the artist filter.
default: dontcare
album: type: string
description: The title of the album. Use 'dontcare' to ignore the album filter.
default: dontcare
genre: type: string
description: The musical style or category. Use 'dontcare' if genre is not a filtering criterion.
enum: Reggae
Holiday
Electropop
Pop
Asia
House
Electronica
Funk
Rock
Metal
Dubstep
Country
dontcare
default: dontcare
year: type: string
description: The year the song was originally released, formatted as 'YYYY'. Use 'dontcare' to ignore the year filter.
enum: 2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
dontcare
default: dontcare
name: Weather_1_GetWeather
description: Retrieves the weather forecast for a specified city on a given date.
parameters: type: dict
required: city
properties: city: type: string
description: The name of the city for which to retrieve the weather, such as 'New York, NY' or 'London, UK'.
date: type: string
description: The date for which to retrieve the weather, in the format 'YYYY-MM-DD'. If not provided, defaults to the current date.
default: 2019-03-01
name: Restaurants_2_ReserveRestaurant
description: Make a table reservation at a specified restaurant on a given date and time for a certain number of guests.
parameters: type: dict
required: restaurant_name
location
time
date
properties: restaurant_name: type: string
description: The name of the restaurant where the table reservation will be made.
location: type: string
description: The city where the restaurant is located, in the format of 'City, State' (e.g., 'New York, NY').
time: type: string
description: The tentative time for the restaurant reservation, in 24-hour format 'HH:MM' (e.g., '19:00' for 7 PM).
number_of_seats: type: integer
description: The number of seats to reserve at the restaurant.
default: 2
date: type: string
description: The tentative date for the restaurant reservation in ISO format 'YYYY-MM-DD' (e.g., '2021-08-15').
name: Restaurants_2_FindRestaurants
description: Search for restaurants based on their location, category, price range, and availability of vegetarian options and outdoor seating.
parameters: type: dict
required: category
location
properties: category: type: string
description: The type of cuisine or food category offered by the restaurant, such as 'Italian', 'Chinese', or 'Vegetarian'.
enum: Mexican
Bistro
Izakaya
Brunch
Thai
Sandwich
Seafood
Barbecue
European
Steakhouse
Vietnamese
Asian
Coffeehouse
American
Gastropub
Austrian
Italian
Indian
Spanish
Vegetarian
Brasserie
Chinese
Breakfast
Greek
California
Tapas
Take-out
Japanese
location: type: string
description: The city or location where the restaurant is situated, in the format of 'City, State', such as 'San Francisco, CA'.
price_range: type: string
description: The price category of the restaurant. The options range from 'cheap' to 'ultra high-end'.
enum: cheap
moderate
pricey
ultra high-end
default: dontcare
has_vegetarian_options: type: boolean
description: Indicates if the restaurant offers vegetarian meal options.
default: no
has_seating_outdoors: type: boolean
description: Indicates if the restaurant provides seating outdoors.
default: no
name: Trains_1_GetTrainTickets
description: Reserve train tickets for a specific journey between two cities on a given date and time, with options for trip protection and class of service.
parameters: type: dict
required: _from
to
date_of_journey
journey_start_time
properties: _from: type: string
description: The departure city for the train journey, such as 'New York, NY'.
to: type: string
description: The destination city for the train journey, such as 'Los Angeles, CA'.
date_of_journey: type: string
description: The date of the train journey, in the format 'MM/DD/YYYY'.
journey_start_time: type: string
description: The departure time of the train, in 24-hour format 'HH:MM'.
number_of_adults: type: integer
description: The number of adult passengers to reserve train tickets for.
default: 1
trip_protection: type: boolean
description: Indicates whether to add trip protection to the reservation, which incurs an additional fee.
default: no
_class: type: string
description: The fare class for the train reservation.
enum: Value
Flexible
Business
default: Value
name: Trains_1_FindTrains
description: Find trains going to a specified destination city on a given date, with options for fare class and number of adult passengers.
parameters: type: dict
required: _from
to
date_of_journey
properties: _from: type: string
description: Starting city for the train journey, in the format of 'City, State', such as 'San Francisco, CA'.
to: type: string
description: Destination city for the train journey, in the format of 'City, State', such as 'Los Angeles, CA'.
date_of_journey: type: string
description: Date of the train journey, in the format 'YYYY-MM-DD', such as '2023-04-15'.
_class: type: string
description: Fare class for the train reservation.
enum: Value
Flexible
Business
default: Value
number_of_adults: type: integer
description: Number of adult passengers to reserve train tickets for.
default: 1
name: youtube.check_videos
description: Verify the existence of YouTube videos based on their title, publisher, and associated tags.
parameters: type: dict
required: title
publisher
tags
properties: title: type: string
description: The exact title of the YouTube video to check.
publisher: type: string
description: The name of the channel or individual who published the video.
tags: type: array
items: type: string
description: An array of strings representing the hashtags associated with the video.
name: youtube.get_video_rating
description: Retrieves the rating of a YouTube video based on its title and publisher.
parameters: type: dict
required: title
publisher
properties: title: type: string
description: The title of the video whose rating is being requested.
publisher: type: string
description: The name of the publisher of the video.
name: version_api.VersionApi.get_version
description: Retrieve the application's name and its current version as a JSON object.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve the details of a project based on its name and version identifier.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project.
version: type: string
description: Semantic version number of the project, in the format 'major.minor.patch'.
name: ProjectApi.update_project
description: Updates the specified project with new information such as its name, status, and description.
parameters: type: dict
required: project_id
project_data
properties: project_id: type: string
description: The unique identifier of the project to be updated.
project_data: type: dict
properties: name: type: string
description: The new name of the project.
status: type: string
description: The current status of the project.
enum: active
inactive
completed
on hold
default: active
description: type: string
description: A brief description of the project.
description: A dictionary containing the updated data for the project.
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: Retrieves the current security metrics, such as the number of vulnerabilities, for a specified project and its version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which to retrieve security metrics.
version: type: string
description: The specific version of the project to query. Follows semantic versioning, e.g., '1.2.3'.
name: badge_api.BadgeApi.get_project_policy_violations_badge1
description: This function retrieves a badge image that indicates whether a specific project version complies with defined policy rules.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project for which the policy violations badge is being queried.
version: type: string
description: The specific version identifier of the project to check for policy violations.
name: get_service_providers
description: Retrieve a list of service providers based on specified criteria.
parameters: type: dict
required: service_id
province_id
properties: service_id: type: integer
description: Unique identifier for the type of service.
province_id: type: integer
description: Unique identifier for the province.
district_name: type: string
description: The name of the district, such as 'Bang Rak' or 'Watthana'.
sub_district_name: type: string
description: The name of the subdistrict, such as 'Thung Maha Mek' or 'Khlong Toei'.
avg_rating: type: float
description: The average review rating of the service provider, on a scale of 1 to 5 stars.
default: 0
start_available_date: type: string
description: The start of the availability date range for the service provider, in the format 'YYYY-MM-DD HH:mm:ss'.
end_available_date: type: string
description: The end of the availability date range for the service provider, in the format 'YYYY-MM-DD HH:mm:ss'.
min_age: type: integer
description: The minimum age of the service provider.
default: 18
max_age: type: integer
description: The maximum age of the service provider.
default: 65
has_late_check_in: type: boolean
description: Indicates if the service provider has a record of late check-in.
default: no
has_quality_problem: type: boolean
description: Indicates if the service provider has a history of quality-related problems.
default: no
is_excellent: type: boolean
description: Indicates if the service provider is considered excellent.
default: no
is_cleaning_condo: type: boolean
description: Indicates if the service provider offers condo cleaning services.
default: no
is_cleaning_home: type: boolean
description: Indicates if the service provider offers home cleaning services.
default: no
is_cleaning_office: type: boolean
description: Indicates if the service provider offers office cleaning services.
default: no
is_package: type: boolean
description: Indicates if the service provider offers booking packages.
default: no
is_subscription: type: boolean
description: Indicates if the service provider offers subscription services.
default: no
available_for_pet: type: boolean
description: Indicates if the service provider can work in environments with pets.
default: no
professional_group_id: type: integer
description: The group to which the service provider belongs, such as 'Group A' or 'Group B'.
enum: Group A
Group B
Group C
default: Group A
job_qty: type: integer
description: The number of jobs the service provider has completed.
default: 0
name: view_service_provider_profile
description: Retrieve and display the profile information of a specified service provider.
parameters: type: dict
required: service_id
properties: service_id: type: integer
description: The unique identifier of the service provider whose profile is to be viewed.
name: set_alarm
description: Set an alarm to trigger at a specified time, optionally with a designated purpose.
parameters: type: dict
required: alarm_time
properties: alarm_time: type: string
description: The alarm time in the format 'YYYY-MM-DD HH:MM:SS', for example, '2023-04-01 07:30:00'.
purpose: type: string
description: A brief description of the alarm's purpose.
default: General reminder
name: set_countdown
description: Initializes a countdown timer for a specified duration with an optional reminder purpose.
parameters: type: dict
required: duration
properties: duration: type: string
description: The countdown duration, expected in the format 'MM:SS', where MM is minutes and SS is seconds.
purpose: type: string
description: A brief description of the purpose of the countdown timer.
default: General Reminder
name: acl_api.AclApi.retrieve_projects
description: Retrieve a list of projects assigned to the specified team, with options to exclude inactive or non-root projects.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the team for which to retrieve assigned projects.
excludeInactive: type: boolean
description: When set to true, inactive projects are excluded from the results.
default: no
onlyRoot: type: boolean
description: When set to true, only root projects are included in the results, excluding any child projects.
default: no
name: project_property_api.ProjectPropertyApi.get_properties
description: Retrieves a list of all project properties associated with the specified project identifier (UUID).
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier of the project for which properties are to be retrieved. It must be a valid UUID format, such as '123e4567-e89b-12d3-a456-426614174000'.
name: finding_api.FindingApi.analyze_project
description: Initiates a vulnerability analysis for the specified project using its unique identifier.
parameters: type: dict
required: uuid
properties: uuid: type: string
description: The unique identifier (UUID) of the project for which the vulnerability analysis is to be performed.
name: set_volume
description: Set the global volume for all audio playback. The volume level can be set within a range from 0 (mute) to 100 (maximum volume).
parameters: type: dict
required: volume
properties: volume: type: integer
description: The volume level to be set. Acceptable values range from 0 (mute) to 100 (maximum volume).
name: set_alarm
description: Set an alarm for a specific time. The time can be specified in various formats, including 'YYYY-MM-DD HH:MM:SS', 'HH:MM:SS', 'HH:MM', or with AM/PM notation. Examples: '2023-06-01 09:30:00', '14:45', '9:30 AM'. This function creates an alarm entry in the system with an optional purpose.
parameters: type: dict
required: alarm_time
properties: alarm_time: type: string
description: The alarm time in a recognized format, such as 'YYYY-MM-DD HH:MM:SS', 'HH:MM:SS', 'HH:MM', or 'HH:MM AM/PM'.
purpose: type: string
description: The purpose of the alarm, such as 'wake up' or 'meeting'.
default: General reminder
name: set_countdown
description: Sets a countdown timer for a specified duration. The duration can be specified in a string format, such as '1h 30m' for 1 hour and 30 minutes, '45m' for 45 minutes, or '2h' for 2 hours.
parameters: type: dict
required: duration
properties: duration: type: string
description: The countdown duration in the format of 'Nh Nm', where 'N' can be any integer representing the number of hours (h) or minutes (m). For example, '1h 30m', '45m', '2h'.
purpose: type: string
description: The purpose of the countdown timer. This is an optional parameter.
default: General reminder
name: play_spotify_song
description: Searches for a song on Spotify using a query and plays it. The query can be a combination of song title and artist name or just the song title.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for the song. It can be in the format 'track:Song Name artist:Artist Name', or just the song name if the artist is unknown. Example: 'track:Shape of You artist:Ed Sheeran'.
autoplay: type: boolean
description: Determines whether the song should start playing automatically. Set to true to autoplay the song.
default: no
volume: type: integer
description: Sets the volume at which the song should play. The value must be between 0 (mute) and 100 (maximum volume).
default: 50
name: set_volume
description: Set the global volume for all audio playback. The volume level can be adjusted from mute to maximum output. The desired volume should be provided as a percentage.
parameters: type: dict
required: volume
properties: volume: type: integer
description: The volume level as a percentage (0-100), where 0 is mute and 100 is the maximum volume.
name: play_song
description: Initiates playback of a song based on a search query provided by the user.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for the song, formatted as 'track:Song Name artist:Artist Name', or just 'track:Song Name' if the artist is not known.
name: set_volume
description: Set the global volume for all audio playback. The volume level can be specified as an integer value ranging from 0 (mute) to 100 (maximum volume).
parameters: type: dict
required: volume
properties: volume: type: integer
description: The volume level to be set for audio playback. Valid range is from 0 to 100, where 0 is completely muted and 100 is the highest volume.
name: play_song
description: Plays the requested song based on the provided search query.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for the song, such as the song's title or artist's name.
volume: type: integer
description: The volume level to play the song at, ranging from 0 (mute) to 100 (maximum volume).
default: 70
shuffle: type: boolean
description: Whether to shuffle the playback when multiple songs match the query.
default: no
name: set_volume
description: Set the global volume for all audio playback. The volume level can be specified as an integer between 0 (mute) and 100 (maximum loudness).
parameters: type: dict
required: volume
properties: volume: type: integer
description: The volume level to be set. Valid values range from 0 (mute) to 100 (maximum loudness).
name: set_alarm
description: Set an alarm for a specific time. The time can be specified in various formats, including 'YYYY-MM-DD HH:MM:SS', 'HH:MM:SS', 'HH:MM', or with AM/PM notations. For example, '2023-06-01 09:30:00', '14:45', or '9:30 AM'.
parameters: type: dict
properties: alarm_time: type: string
description: The alarm time in a recognized format, such as 'YYYY-MM-DD HH:MM:SS' for specific date and time, 'HH:MM:SS' for time only, 'HH:MM' for hour and minutes, or 'HH:MM AM/PM' for 12-hour format.
purpose: type: string
description: The purpose of setting the alarm. This could be a brief reminder or a description of the event.
default: General reminder
required: alarm_time
name: set_countdown
description: Sets a countdown timer based on the provided duration, which should be specified in either hours, minutes, or a combination of both. For example, valid inputs include '1 hour', '30 minutes', and '1 hour 30 minutes'.
parameters: type: dict
required: duration
properties: duration: type: string
description: The countdown duration specified as a string in one of the following formats: 'X hour(s) Y minute(s)', 'X hour(s)', or 'Y minute(s)'. Examples: '1 hour 30 minutes', '45 minutes', '2 hours'.
enum: 1 hour
30 minutes
1 hour 30 minutes
45 minutes
2 hours
purpose: type: string
description: An optional description of the purpose for the countdown timer.
default: General reminder
name: play_song
description: Play a song based on the user's search query. The function searches for the song in the music database and plays the first match.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for the song, which can include song title, artist, or album.
volume: type: integer
description: The volume level at which the song should be played, ranging from 0 to 100.
default: 75
shuffle: type: boolean
description: Indicates whether to shuffle the playlist after playing the requested song.
default: no
repeat: type: string
description: Specifies the repeat mode for the song playback.
enum: none
one
all
default: none
name: set_alarm
description: Set an alarm for a specific time. The time can be specified in various formats, such as 'YYYY-MM-DD HH:MM:SS', 'HH:MM:SS', 'HH:MM', or with AM/PM. Examples: '2023-06-01 09:30:00', '14:45', '9:30 AM'.
parameters: type: dict
required: alarm_time
properties: alarm_time: type: string
description: The alarm time in a valid time format, such as 'YYYY-MM-DD HH:MM:SS', 'HH:MM:SS', 'HH:MM', or 'HH:MM AM/PM'.
purpose: type: string
description: The purpose of the alarm. For example, 'wake-up call' or 'meeting reminder'.
default: General alarm
name: set_countdown
description: Set a countdown timer for a specified duration. The duration should be specified as a string in the format of 'X hours Y minutes', such as '1 hour 30 minutes', '45 minutes', or '2 hours'.
parameters: type: dict
required: duration
properties: duration: type: string
description: The countdown duration. Acceptable formats include combinations of hours and minutes (e.g., '1 hour 30 minutes', '45 minutes', '2 hours').
purpose: type: string
description: The purpose of the countdown timer, such as 'meeting' or 'break time'.
default: general reminder
enum: meeting
break time
workout
meditation
general reminder
name: play_song
description: Plays the user's requested song based on the provided search query.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for the song, such as the song's title, artist, or album.
volume: type: integer
description: The volume level to play the song at, ranging from 0 (mute) to 100 (maximum volume).
default: 70
shuffle: type: boolean
description: Indicates whether to shuffle the playback queue after the requested song is added.
default: no
repeat: type: string
description: Specifies the repeat mode for the song playback.
enum: none
one
all
default: none
name: set_alarm
description: Set an alarm for a specific time. The time can be specified in various formats, including 'YYYY-MM-DD HH:MM:SS' for specific dates, 'HH:MM:SS' or 'HH:MM' for time only, and 'HH:MM AM/PM' for 12-hour format. Examples: '2023-06-01 09:30:00', '14:45:00', '9:30 AM'.
parameters: type: dict
required: alarm_time
properties: alarm_time: type: string
description: The alarm time in a recognized format such as 'YYYY-MM-DD HH:MM:SS', 'HH:MM:SS', 'HH:MM', or 'HH:MM AM/PM'.
purpose: type: string
description: The purpose of the alarm, such as 'wake up' or 'meeting'.
default: General reminder
name: play_song
description: Plays the specified song based on a search query provided by the user.
parameters: type: dict
required: query
properties: query: type: string
description: The search query for the song, which may include title, artist, or album name.
shuffle: type: boolean
description: Determines if the song playback should be shuffled. If true, plays songs in random order.
default: no
repeat: type: boolean
description: Determines if the song should be repeated after it finishes playing.
default: no
volume: type: integer
description: The volume level to play the song at, ranging from 0 (mute) to 100 (maximum volume).
default: 70
name: version_api.VersionApi.get_version
description: Retrieve the current version of the application, including its name and version number in a JSON format.
parameters: type: dict
name: oidc_api.OidcApi.is_available
description: Checks if OpenID Connect authentication is supported for the current application, which enables single sign-on capabilities.
parameters: type: dict
properties: application_id: type: string
description: The unique identifier of the application for which to check OpenID Connect availability.
required: application_id
name: project_api.ProjectApi.update_project
description: Updates the specified attributes of a project based on the provided project ID.
parameters: type: dict
required: project_id
project_data
properties: project_id: type: string
description: The unique identifier of the project to be updated.
project_data: type: dict
description: A dictionary containing key-value pairs of the project attributes to be updated.
properties: name: type: string
description: The new name of the project.
description: type: string
description: The new description of the project.
status: type: string
description: The new status of the project.
enum: active
inactive
archived
default: active
deadline: type: string
description: The updated project completion deadline in 'YYYY-MM-DD' format.
default: null
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve details of a specific project identified by a combination of its name and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name of the project.
version: type: string
description: The specific version of the project, following semantic versioning, such as '1.0.0'.
name: repository_api.RepositoryApi.get_repository_meta_component
description: Resolves the latest version of a specified component from the configured repositories.
parameters: type: dict
required: purl
properties: purl: type: string
description: The Package URL (PURL) for the component whose latest version needs to be resolved.
include_prereleases: type: boolean
description: Flag to include pre-release versions in the resolution process.
default: no
name: uber.eat.order
description: Order food on Uber Eats by specifying the restaurant and the items with their respective quantities.
parameters: type: dict
required: restaurant
items
quantities
properties: restaurant: type: string
description: The name of the restaurant from which to order food.
items: type: array
items: type: string
description: A list of names of selected food items to be ordered.
quantities: type: array
items: type: integer
description: A list of quantities corresponding to each item in the order, indexed in the same order as the items.
notes: type: string
description: Special instructions or notes for the restaurant regarding the order.
delivery_option: type: string
description: The preferred delivery option for the order.
enum: standard
express
default: standard
name: flight.status.check
description: Check the current status of a flight using the flight's identifier and the ticket details of the passenger.
parameters: type: dict
required: flight_identifier
passenger_name
ticket_number
properties: flight_identifier: type: string
description: Unique identifier for the flight, such as a flight number.
passenger_name: type: string
description: Full name of the passenger as it appears on the ticket.
ticket_number: type: string
description: Alphanumeric ticket number associated with the passenger's booking.
name: flight.status.check
description: Checks the current status of a flight by airline, passenger name, and ticket number.
parameters: type: dict
required: airlines
person_name
ticket_number
properties: airlines: type: string
description: The name of the airline company for which to check the flight status. For example, 'Delta', 'United'.
enum: Delta
United
American
Southwest
JetBlue
person_name: type: string
description: The full name of the passenger as it appears on the ticket.
ticket_number: type: string
description: The unique ticket number associated with the passenger's flight booking.
name: uber.eat.order
description: Place an order for food through Uber Eats by specifying the restaurant and the items with their corresponding quantities.
parameters: type: dict
required: restaurant
items
quantities
properties: restaurant: type: string
description: The name of the restaurant from which to order food.
items: type: array
items: type: string
description: A list of names of the selected items from the menu.
quantities: type: array
items: type: integer
description: A list of quantities for each item ordered, corresponding by index to the items listed in the 'items' parameter.
name: user.mandates
description: Fetches the mandates associated with a user based on the provided user name and the status of the mandates. This API is intended for use by partners to retrieve information about their clients' mandates.
parameters: type: dict
required: name
properties: name: type: string
description: The full name of the partner's client for whom to fetch mandates.
status: type: string
description: The status of the mandates to be fetched. If omitted, mandates of all statuses will be retrieved.
enum: active
pending
inactive
default: active
name: partner.mandates
description: Fetches the mandates associated with a partner based on the specified status. If no status is provided, all mandates are retrieved.
parameters: type: dict
properties: status: type: string
description: The status of the mandates to be fetched. If left empty, mandates with any status will be retrieved.
enum: active
pending
inactive
default: all
name: client.mandates
description: Fetches the mandates of a single client based on the client's name and the status of the mandate. Partners can use this API to retrieve mandate information for their clients.
parameters: type: dict
required: name
properties: name: type: string
description: The full name of the client whose mandates are to be fetched.
status: type: string
description: The status of the mandates to be fetched. If not specified, mandates with all statuses are retrieved.
enum: active
pending
inactive
default: active
name: partner.mandates
description: Fetches all mandates for all clients associated with a partner, filtered by the status of the mandates.
parameters: type: dict
required: status
properties: status: type: string
description: The status of mandates to fetch. Possible values are 'active', 'pending', and 'inactive'.
enum: active
pending
inactive
name: partner.sips
description: Fetch all Systematic Investment Plans (SIPs) of all clients associated with a partner, filtered by the given status of the SIP.
parameters: type: dict
required: status
properties: status: type: string
description: The status of the SIPs to be fetched. Valid statuses include 'active', 'stopped', and 'paused'.
enum: active
stopped
paused
name: get_current_weather
description: Retrieves the current weather conditions for a specified location.
parameters: type: dict
required: location
properties: location: type: string
description: The city and state for which to get the weather, in the format of 'City, State', such as 'San Francisco, CA' or 'New York, NY'.
unit: type: string
description: The unit of measurement for temperature values.
enum: celsius
fahrenheit
default: fahrenheit
name: web_search
description: Perform a web search for a given query and return relevant results.
parameters: type: dict
required: query
properties: query: type: string
description: The search query string to be used for finding relevant web pages.
results_limit: type: integer
description: The maximum number of search results to return. The value must be a positive integer.
default: 10
language: type: string
description: The language preference for the search results.
enum: en
es
fr
de
it
default: en
safe_search: type: boolean
description: Enable or disable safe search filtering.
default: yes
name: handover_to_agent
description: This function initiates the handover process to transfer an ongoing chat session from a bot to a live human agent.
parameters: type: dict
required: chat_id
agent_id
properties: chat_id: type: string
description: Unique identifier of the chat session that needs to be transferred.
agent_id: type: string
description: Unique identifier of the human agent to whom the chat will be transferred.
priority: type: string
description: The priority level for the chat handover.
enum: low
medium
high
default: medium
message: type: string
description: An optional message to the agent about the chat or customer.
name: GET_PARCEL_STATE
description: Determines the current state of the parcel, such as 'In Transit', 'Delivered', or 'Awaiting Pickup', based on the provided tracking ID.
parameters: type: dict
required: parcelTrackingId
properties: parcelTrackingId: type: string
description: Unique identifier for the parcel used to track its movement and status.
includeHistory: type: boolean
description: Determines if the historical states of the parcel should be included in the response.
default: no
name: transfer_to_human_agent
description: This function facilitates the handover of a chat conversation from a virtual assistant to a human agent, ensuring the user receives appropriate assistance for complex issues that require human intervention.
parameters: type: dict
required: statement
properties: statement: type: string
description: A message provided by the user that describes the issue they are facing, which prompts the handover to a human agent.
name: get_parcel_state
description: Retrieves the current status of a parcel based on its tracking ID.
parameters: type: dict
required: parcelTrackingId
properties: parcelTrackingId: type: string
description: The unique identifier for tracking the parcel. Typically an alphanumeric code.
name: answer_question
description: Transfers the chat to a human agent in case the query cannot be resolved automatically.
parameters: type: dict
required: statement
properties: statement: type: string
description: The specific question posed by the user that needs to be addressed by a human agent.
urgency_level: type: string
description: The urgency level of the user's query.
enum: low
medium
high
default: low
language: type: string
description: The language in which the question is asked.
enum: English
Spanish
French
German
Chinese
default: English
name: handover_to_agent
description: This function initiates a transfer of the current chat session to a human agent. It is typically invoked when the automated system determines that it cannot adequately address the user's query.
parameters: type: dict
required: statement
properties: statement: type: string
description: The initial query or statement made by the user that prompts the transfer to a human agent.
urgency: type: string
description: Indicates the level of urgency for the handover to a human agent.
enum: low
medium
high
default: low
language: type: string
description: The language of the user's statement, represented as an ISO 639-1 two-letter language code, such as 'en' for English or 'es' for Spanish.
default: en
context: type: string
description: Additional context or information about the conversation that may assist the human agent.
name: GET_PARCEL_STATE
description: Retrieves the current state of a parcel using its tracking ID.
parameters: type: dict
required: parcelTrackingId
properties: parcelTrackingId: type: string
description: The unique identifier for tracking the parcel.
name: transfer_to_human_agent
description: Transfers the chat interaction to a human agent when automated responses cannot handle the user's question.
parameters: type: dict
required: statement
properties: statement: type: string
description: The question or statement from the user prompting the transfer.
urgency: type: string
description: The urgency level of the request, indicating how quickly a human agent should take over the chat.
enum: low
medium
high
default: medium
language: type: string
description: The language in which the user is communicating. This helps in routing to a human agent fluent in that language.
enum: English
Spanish
French
German
Mandarin
default: English
name: handover_to_human_agent
description: This function initiates the process of transferring the ongoing chat from an automated system to a human agent. It ensures the user's question is appropriately handed over for further personalized assistance.
parameters: type: dict
required: statement
properties: statement: type: string
description: The user's question or statement that prompts the handover to a human agent.
urgency_level: type: string
description: The level of urgency for the chat handover, determining the priority in the support queue.
enum: low
medium
high
default: medium
user_id: type: string
description: A unique identifier for the user to maintain chat continuity during the handover.
default: anonymous
name: uber.eat.order
description: Place an order on Uber Eats, specifying the restaurant and the quantities of selected items.
parameters: type: dict
required: restaurant
items
properties: restaurant: type: string
description: The name of the restaurant from which to order food, formatted as 'Restaurant Name, Location', such as 'Pizzeria Uno, Chicago, IL'.
items: type: array
items: type: string
description: List of selected item names.
quantities: type: array
items: type: integer
description: List of quantities corresponding to each selected item, aligned by index with the 'items' array. If not specified, a default quantity of 1 is assumed for each item.
name: uber.ride
description: Find a suitable Uber ride for customers based on their location, selected ride type, and maximum wait time.
parameters: type: dict
required: loc
type
time
properties: loc: type: string
description: The starting location for the Uber ride, in the format of 'Address, City, State'.
type: type: string
description: The type of Uber ride the user is requesting.
enum: plus
comfort
black
time: type: integer
description: The maximum amount of time, in minutes, the customer is willing to wait for the ride.
name: uber.eat.order
description: Place an order for food on Uber Eats, specifying the restaurant, items, and their respective quantities.
parameters: type: dict
required: restaurant
items
quantities
properties: restaurant: type: string
description: The name of the restaurant from which to order food.
items: type: array
items: type: string
description: An array of item names selected from the restaurant's menu.
quantities: type: array
items: type: integer
description: An array of integers representing the quantity for each item in the same order as the 'items' array. Each quantity corresponds to the respective item by index.
name: fmp.income_statement
description: Fetches income statement data for a given stock symbol or Central Index Key (CIK), for a specified period. The user may also specify the data format and the maximum number of records to return.
parameters: type: dict
required: symbol
period
properties: symbol: type: string
description: The stock symbol or company identifier, such as 'AAPL' for Apple Inc.
period: type: string
description: The reporting period for which the income statement is to be fetched, such as 'annual' or 'quarter'.
enum: annual
quarter
cik: type: string
description: The Central Index Key (CIK) of the company, which is a unique identifier assigned by the SEC.
datatype: type: string
description: The format in which the data will be returned, with options 'json' and 'csv'.
enum: json
csv
default: json
limit: type: integer
description: The maximum number of records to return. Defaults to 10 if not specified.
default: 10
name: version_api.VersionApi.get_version
description: Retrieve the application's version information, including the application name and its current version.
parameters: type: dict
name: project_api.ProjectApi.get_project_by_name_and_version
description: Retrieve the details of a specific project using its name and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier for the project.
version: type: string
description: The release version of the project, formatted as 'major.minor.patch' (e.g., '1.0.0').
name: project_api.update_project
description: Update the details of an existing project by providing the project ID and the new details to be updated.
parameters: type: dict
required: project_id
project_details
properties: project_id: type: string
description: The unique identifier of the project to be updated.
project_details: type: dict
properties: name: type: string
description: The new name of the project.
description: type: string
description: A brief description of the project.
status: type: string
description: The current status of the project.
enum: active
inactive
completed
on_hold
description: A dictionary containing the details of the project that are to be updated.
name: badge_api.BadgeApi.get_project_vulnerabilities_badge
description: Retrieves the current security vulnerability metrics for a specified project and version.
parameters: type: dict
required: name
version
properties: name: type: string
description: The unique name identifier of the project.
version: type: string
description: The specific version of the project for which to retrieve vulnerability metrics.
name: repository_api.update_repository
description: Updates the metadata and settings of an existing repository on the platform.
parameters: type: dict
required: repository_id
repository_data
properties: repository_id: type: string
description: The unique identifier of the repository to update.
repository_data: type: dict
description: A dictionary containing the data to update the repository with.
properties: name: type: string
description: The new name of the repository.
description: type: string
description: A brief description of the repository.
is_private: type: boolean
description: Flag to make the repository private or public.
default: no
default_branch: type: string
description: The name of the default branch for the repository.
default: main